Skip to content

[docs] Document ASPIRE013 and scope ASPIRE010 to non-C# AppHosts - #2071

Merged
Sébastien Ros (sebastienros) merged 6 commits into
release/17.0from
docs/pr-21288-42166733916-1-375b5dd597b8e0d3
Nov 13, 2026
Merged

Sébastien Ros (sebastienros) merged 6 commits into
release/17.0from
docs/pr-21288-42166733916-1-375b5dd597b8e0d3

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#21288 by @IEvangelist-triggered run (PR author per source PR).

Targeting release/17.0 based on the source PR milestone 17.0 (exact match).

Why

The source PR restores ASPIRE010 as the suppressible warning for non-C# AppHosts that opt out of the CLI bundle, and introduces ASPIRE013 as the unsuppressible error for C# AppHosts. Signals: diagnostic_documentation_changed, pr_body_has_cli_flag_mention, pr_body_has_user_facing_section.

Changes

  • New: diagnostics/aspire013.mdx
  • Updated: diagnostics/aspire010.mdx (non-C# scope, mutually exclusive with ASPIRE013), diagnostics/overview.mdx (ASPIRE013 row), diagnostics/aspire009.mdx, get-started/aspire-sdk.mdx

The ASPIRE013 "Version introduced" badge is set to 17.0 (target branch); SME please confirm.

Generated by PR Documentation Check for #21288 · copilot · auto · 30 AIC · ⌖ 1.4 AIC · ⊞ 7.4K · ◷

@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Nov 6, 2026
@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review November 13, 2026 14:54
Copilot AI balanced review requested due to automatic review settings November 13, 2026 14:54

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The SDK documentation still describes an obsolete opt-in configuration, contradicting the mandatory C# bundle requirement and ASPIRE013 guidance and misleading users about which configurations remain valid.

1 open issue
What changed in this PR

Updates Aspire diagnostic documentation for the C# CLI-bundle requirement introduced by microsoft/aspire#21288, targeting release 17.0.

Changes:

  • Adds ASPIRE013 documentation for the unsuppressible C# AppHost error.
  • Scopes ASPIRE010 to non-C# AppHosts and updates ASPIRE009 recovery guidance.
  • Adds ASPIRE013 to the diagnostics index and updates the SDK guide.
File Description
src/​frontend/​src/​content/​docs/​get-started/​aspire-sdk.mdx Describes language-specific CLI-bundle requirements.
src/​frontend/​src/​content/​docs/​diagnostics/​overview.mdx Lists ASPIRE013 as an error.
src/​frontend/​src/​content/​docs/​diagnostics/​aspire013.mdx Adds error details, an example, and corrective steps.
src/​frontend/​src/​content/​docs/​diagnostics/​aspire010.mdx Limits the warning and examples to non-C# AppHosts.
src/​frontend/​src/​content/​docs/​diagnostics/​aspire009.mdx Distinguishes bundle-resolution remedies by AppHost language.

Review effort: Balanced

When it uses the Aspire CLI bundle, those binaries update when you update the Aspire CLI through [`aspire update --self`](/reference/cli/commands/aspire-update/). Without the bundle, the Aspire SDK version used by the AppHost determines the binaries by adding implicit references to the RID-specific `Aspire.Hosting.Orchestration.*` and `Aspire.Dashboard.Sdk.*` packages.

New C# AppHost projects created with `aspire new` or `dotnet new`, and new single-file AppHosts created with `aspire init`, set `AspireUseCliBundle` to `true` automatically. For existing AppHosts, set `AspireUseCliBundle` to `true` to enable the CLI bundle. We recommend enabling it now because the CLI bundle will become the only supported source for orchestration dependencies in an upcoming Aspire release. The SDK property currently defaults to `false`, so launching a C# AppHost with `dotnet run` or an IDE continues to work without requiring the Aspire CLI. Leaving it unset (or explicitly `false`) reports warning [`ASPIRE010`](/diagnostics/aspire010/) as a reminder that some Aspire features require the bundle; suppress it if you intend to keep using NuGet-restored orchestration dependencies.
New C# AppHost projects created with `aspire new` or `dotnet new`, and new single-file AppHosts created with `aspire init`, set `AspireUseCliBundle` to `true` automatically. For existing AppHosts, set `AspireUseCliBundle` to `true` to enable the CLI bundle. We recommend enabling it now because the CLI bundle will become the only supported source for orchestration dependencies in an upcoming Aspire release. The SDK property currently defaults to `false`, so launching a C# AppHost with `dotnet run` or an IDE continues to work without requiring the Aspire CLI. C# AppHosts require the CLI bundle, so setting `AspireUseCliBundle` to `false` reports error [`ASPIRE013`](/diagnostics/aspire013/), and suppressing `ASPIRE013` doesn't bypass the requirement. Non-C# AppHosts that set it to `false` report the suppressible warning [`ASPIRE010`](/diagnostics/aspire010/).
- C# AppHosts default AspireUseCliBundle to true and can't opt out (ASPIRE013)
- Non-C# AppHosts default to false, so ASPIRE010 also fires when unset
- Use a realistic .fsproj file name in ASPIRE010 examples
- Register the ASPIRE013 page in the diagnostics sidebar (fixes the build)
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #2071. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #2071 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

The unknown-arguments example ran 'aspire destroy --force' in a bash block,
which the pipeline command options unit test flags as an undocumented option.
Describe the invalid option in prose and keep the error output.
@sebastienros
Sébastien Ros (sebastienros) merged commit 74bc014 into release/17.0 Nov 13, 2026
16 checks passed
@sebastienros
Sébastien Ros (sebastienros) deleted the docs/pr-21288-42166733916-1-375b5dd597b8e0d3 branch November 13, 2026 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants