From 69962a2ed70742bd70221ad1c281d27914a920f2 Mon Sep 17 00:00:00 2001 From: David Fowler Date: Fri, 2 Oct 2026 08:55:08 -0700 Subject: [PATCH 1/2] Clarify .NET SDK requirements in CLI and deployment docs Remove the blanket CLI SDK prerequisite and scope CI SDK setup to the C# AppHost and .NET API examples. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- src/frontend/src/content/docs/deployment/docker-compose.mdx | 6 +++--- .../src/content/docs/integrations/compute/docker.mdx | 6 +++--- .../content/docs/reference/cli/commands/aspire-doctor.mdx | 4 ++-- src/frontend/src/content/docs/reference/cli/overview.mdx | 6 ------ src/frontend/src/content/docs/reference/overview.mdx | 2 +- 5 files changed, 9 insertions(+), 15 deletions(-) diff --git a/src/frontend/src/content/docs/deployment/docker-compose.mdx b/src/frontend/src/content/docs/deployment/docker-compose.mdx index 01c80a9e2..b55a1a80c 100644 --- a/src/frontend/src/content/docs/deployment/docker-compose.mdx +++ b/src/frontend/src/content/docs/deployment/docker-compose.mdx @@ -732,7 +732,7 @@ echo $GITHUB_TOKEN | docker login ghcr.io -u your-github-username --password-std ## GitHub Actions example -The following GitHub Actions workflow builds and pushes container images to GitHub Container Registry (GHCR): +The following GitHub Actions workflow builds and pushes container images to GitHub Container Registry (GHCR) using the C# AppHost and .NET API shown above. The .NET setup step provides the SDK for those projects. Adapt the runtime setup steps to match your AppHost language and the services you build. ```yaml title=".github/workflows/build-and-push.yml" name: Build and Push Images @@ -751,7 +751,7 @@ jobs: steps: - uses: actions/checkout@v4 - - name: Setup .NET + - name: Set up .NET for the C# AppHost and API uses: actions/setup-dotnet@v4 with: dotnet-version: '10.0.x' @@ -778,7 +778,7 @@ jobs: run: aspire do push ``` -This workflow checks out your code, sets up .NET and installs the Aspire CLI, authenticates to GHCR using the built-in `GITHUB_TOKEN`, and builds and pushes container images using `aspire do push`. +This workflow checks out your code, sets up .NET for the C# AppHost and API, and installs the Aspire CLI. It then authenticates to GHCR using the built-in `GITHUB_TOKEN` and builds and pushes container images using `aspire do push`. ## See also diff --git a/src/frontend/src/content/docs/integrations/compute/docker.mdx b/src/frontend/src/content/docs/integrations/compute/docker.mdx index 9533fc71a..0a4e99d44 100644 --- a/src/frontend/src/content/docs/integrations/compute/docker.mdx +++ b/src/frontend/src/content/docs/integrations/compute/docker.mdx @@ -866,7 +866,7 @@ echo $GITHUB_TOKEN | docker login ghcr.io -u your-github-username --password-std ### GitHub Actions workflow example -Here's an example GitHub Actions workflow that builds and pushes images to GHCR: +The following GitHub Actions workflow builds and pushes images to GHCR using the C# AppHost and .NET API shown above. The .NET setup step provides the SDK for those projects. Adapt the runtime setup steps to match your AppHost language and the services you build. ```yaml title=".github/workflows/build-and-push.yml" name: Build and Push Images @@ -885,7 +885,7 @@ jobs: steps: - uses: actions/checkout@v4 - - name: Setup .NET + - name: Set up .NET for the C# AppHost and API uses: actions/setup-dotnet@v4 with: dotnet-version: '10.0.x' @@ -915,7 +915,7 @@ jobs: This workflow: - Checks out your code -- Sets up .NET and installs the Aspire CLI +- Sets up .NET for the C# AppHost and API, then installs the Aspire CLI - Authenticates to GHCR using the built-in `GITHUB_TOKEN` - Builds and pushes container images using [`aspire do push`](/reference/cli/commands/aspire-do/) diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx index e8c3b76b0..b09a0d5f8 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx @@ -18,7 +18,7 @@ aspire doctor [options] ## Description -The `aspire doctor` command runs a series of diagnostic checks to verify that your development environment is properly configured for Aspire development. It checks prerequisites such as the .NET SDK, container runtime, and environment settings. +The `aspire doctor` command runs a series of diagnostic checks to help troubleshoot your Aspire development environment. It checks SDKs, container runtimes, and environment settings.