Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/frontend/src/content/docs/deployment/docker-compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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'
Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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'
Expand Down Expand Up @@ -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/)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 you troubleshoot your Aspire development environment. It checks SDKs, container runtimes, and environment settings.

<Aside type="note">
The `aspire doctor` command replaces the hidden `aspire setup` command. If you
Expand All @@ -31,7 +31,7 @@ This command is useful for troubleshooting when you encounter issues with Aspire

- **Aspire checks**: Reports the current Aspire CLI version and whether a newer CLI version is available, and suggests running `aspire update` when a newer one is available
- **AppHost checks**: Reports the AppHost Aspire SDK version when an AppHost project is present in the current directory
- **SDK checks**: Verifies .NET SDK installation and version requirements
- **SDK checks**: Reports .NET SDK availability and version
- **Container checks**: Validates container runtime (Docker and/or Podman) availability, running status, and version. Reports which runtime is active and why (explicit configuration, auto-detected default, or auto-detected only runtime running)
- **Environment checks**: Reports operating system information (type, version, and Linux distro details when available) and validates environment variables and other settings, including the JavaScript toolchain required by TypeScript AppHosts (npm, pnpm, Yarn, or Bun)
- **Development tools checks**: When VS Code is detected, reports whether the [Aspire VS Code extension](https://aka.ms/aspire/vscode-extension) is installed
Expand Down
6 changes: 0 additions & 6 deletions src/frontend/src/content/docs/reference/cli/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ The Aspire CLI (`aspire` command) is a cross-platform tool that provides command
Only run Aspire CLI commands from repositories and directories that you trust.
:::

<Aside type="note">
Starting with Aspire 13.0, the Aspire CLI requires .NET SDK version 10.0.100
or later. Ensure that you have the appropriate .NET SDK installed to use the
Aspire CLI.
</Aside>

The Aspire CLI is an interactive-first experience.

<CardGrid>
Expand Down
2 changes: 1 addition & 1 deletion src/frontend/src/content/docs/reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Every `aspire` command is designed to be discoverable and interactive. Pass `--h
icon: 'heart',
title: 'aspire doctor',
description:
'Diagnose your development environment. Checks for .NET SDK, container runtime, and other prerequisites.',
'Diagnose your development environment. Checks SDKs, container runtimes, and environment settings.',
href: '/reference/cli/commands/aspire-doctor/',
},
]}
Expand Down
Loading