Skip to content

[docs] Add AspireUseCliBundle opt-in documentation#894

Merged
davidfowl merged 6 commits into
release/13.4from
docs/apphost-cli-bundle-opt-in-8946f0043c008c37
May 11, 2026
Merged

[docs] Add AspireUseCliBundle opt-in documentation#894
davidfowl merged 6 commits into
release/13.4from
docs/apphost-cli-bundle-opt-in-8946f0043c008c37

Conversation

@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#16811@DamianEdwards

Targeting release/13.4 based on the source PR milestone 13.4.

Why this PR is needed

PR microsoft/aspire#16811 introduces a new opt-in MSBuild property AspireUseCliBundle=true that allows C# SDK-style AppHost projects to source DCP and the Aspire Dashboard from the Aspire CLI bundle rather than from the platform-specific Aspire.Hosting.Orchestration.* and Aspire.Dashboard.Sdk.* NuGet packages. This is a user-facing behavior change for AppHost authors who want to decouple their projects from NuGet-distributed orchestration binaries.

The existing Advanced orchestration properties section in app-host/configuration.mdx already documented DcpCliPath, making it the natural home for the new AspireUseCliBundle, AspireCliBundlePath, and AspireCliPath properties.

What was changed

Added a new AspireUseCliBundle subsection to src/frontend/src/content/docs/app-host/configuration.mdx that documents:

  • What AspireUseCliBundle=true does (opt-in, skips NuGet package references, resolves DCP/Dashboard from CLI bundle)
  • How to enable the opt-in in a .csproj file
  • How to override the bundle or CLI path using AspireCliBundlePath / AspireCliPath
  • How aspire run passes bundle paths via ASPIRE_DCP_PATH / ASPIRE_DASHBOARD_PATH
  • Error ASPIRE009 and the (get.aspire.dev/redacted) install link
  • A note that this is a preview opt-in feature

Files modified

  • src/frontend/src/content/docs/app-host/configuration.mdx (updated — added AspireUseCliBundle section)

Generated by PR Documentation Check for issue #16811 · ● 13.6M ·

@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label May 9, 2026
@aspire-repo-bot aspire-repo-bot Bot requested a review from davidfowl May 9, 2026 00:09
@davidfowl davidfowl requested a review from DamianEdwards May 11, 2026 05:02
@IEvangelist IEvangelist force-pushed the docs/apphost-cli-bundle-opt-in-8946f0043c008c37 branch from 62a2206 to ba14385 Compare May 11, 2026 12:24
@IEvangelist IEvangelist removed the request for review from davidfowl May 11, 2026 12:25
@IEvangelist IEvangelist marked this pull request as ready for review May 11, 2026 12:25
@IEvangelist IEvangelist self-requested a review as a code owner May 11, 2026 12:25
Document the new AspireUseCliBundle MSBuild property introduced in
microsoft/aspire#16811 that allows AppHost projects to source DCP and
the Aspire Dashboard from the Aspire CLI bundle instead of platform-
specific NuGet packages.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist IEvangelist force-pushed the docs/apphost-cli-bundle-opt-in-8946f0043c008c37 branch from ba14385 to 7842d14 Compare May 11, 2026 16:40
davidfowl and others added 4 commits May 11, 2026 10:04
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@davidfowl davidfowl requested a review from eerhardt as a code owner May 11, 2026 17:17
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@davidfowl davidfowl merged commit efdb602 into release/13.4 May 11, 2026
5 checks passed
@davidfowl davidfowl deleted the docs/apphost-cli-bundle-opt-in-8946f0043c008c37 branch May 11, 2026 18:37
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.

1 participant