diff --git a/src/frontend/src/content/docs/get-started/aspire-sdk.mdx b/src/frontend/src/content/docs/get-started/aspire-sdk.mdx index ad75e3510..cce314199 100644 --- a/src/frontend/src/content/docs/get-started/aspire-sdk.mdx +++ b/src/frontend/src/content/docs/get-started/aspire-sdk.mdx @@ -108,6 +108,8 @@ Today, the Aspire SDK restores the binaries for these dependencies from platform Aspire is moving toward using the installed **Aspire CLI bundle** as the source for those orchestration dependencies. With this model, those binaries update when you update the Aspire CLI through [`aspire update --self`](/reference/cli/commands/aspire-update/) instead of being tied to RID-specific `Aspire.Hosting.Orchestration.*` and `Aspire.Dashboard.Sdk.*` package references in each AppHost project. +New C# AppHost projects created with `aspire new` or `dotnet new`, and single-file AppHosts created with `aspire init`, opt in to `AspireUseCliBundle` by default. Existing AppHost projects need to set it explicitly to opt in during the transition before this behavior becomes the default for all AppHosts. + Set `AspireUseCliBundle` to `true` to opt in during the transition before this behavior becomes the default. When `AspireUseCliBundle` is `true`: @@ -129,6 +131,12 @@ Set `AspireUseCliBundle` in your AppHost `.csproj`: ``` +For a single-file AppHost created with [`aspire init`](/reference/cli/commands/aspire-init/), set the equivalent `#:property` directive: + +```csharp title="apphost.cs" +#:property AspireUseCliBundle=true +``` + :::note[Advanced scenario: Override the bundle path] Most apps don't need to set the CLI bundle path. If the Aspire CLI isn't on `PATH`, provide an explicit path using `AspireCliBundlePath` (path to the CLI bundle directory) or `AspireCliPath` (path to the `aspire` executable): diff --git a/src/frontend/src/content/docs/whats-new/aspire-13-5.mdx b/src/frontend/src/content/docs/whats-new/aspire-13-5.mdx index 39914b986..8806d0736 100644 --- a/src/frontend/src/content/docs/whats-new/aspire-13-5.mdx +++ b/src/frontend/src/content/docs/whats-new/aspire-13-5.mdx @@ -160,6 +160,14 @@ The Aspire CLI is now available as an npm package (`@microsoft/aspire-cli`), pro - **TypeScript AppHosts honor --no-build**: TypeScript AppHosts now correctly skip the TypeScript compilation check when the --no-build flag is passed. - **CLI shutdown responsiveness**: Multiple improvements to Ctrl+C/SIGTERM handling, including faster signal responsiveness during AppHost startup. +## 📦 Aspire CLI bundle enabled by default in new C# AppHost templates + +New C# AppHost projects and single-file AppHosts created with `aspire new`, `dotnet new`, or `aspire init` now set `AspireUseCliBundle` to `true` automatically, so they use the installed Aspire CLI bundle for DCP and Dashboard orchestration dependencies without an opt-in warning. Existing AppHost projects are unaffected and can opt in manually. + + + For setup details, see [Use the Aspire CLI bundle for orchestration dependencies](/get-started/aspire-sdk/#use-the-aspire-cli-bundle-for-orchestration-dependencies) in the Aspire SDK documentation. + + ## 📊 Dashboard and telemetry improvements - **Timestamp filter for telemetry**: Filter logs and traces by timestamp using a dedicated search qualifier in the Dashboard filter dialog.