From 522d880a5e701f7208c5ab73e3472fbcd0222262 Mon Sep 17 00:00:00 2001 From: Maddy Montaquila Date: Mon, 16 Nov 2026 13:15:38 -0500 Subject: [PATCH 1/3] docs: consolidate 17.0 retired experimental diagnostics Mark the experimental diagnostics that graduated in Aspire 17.0 as retired with a consistent "Retired in: 17.0" badge and note, update the diagnostics overview, add a consolidated What's new section, and remove stale suppressions across the docs. Supersedes #1846, #1847, #1851, #1852, #1853, #1854, #1856, #1857, #2127, #2167, #2168, #2169, #2170, and #2171. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .../content/docs/app-host/withdockerfile.mdx | 10 --- .../docs/deployment/custom-deployments.mdx | 6 +- .../docs/deployment/docker-compose.mdx | 8 -- .../docs/deployment/javascript-apps.mdx | 18 ----- .../src/content/docs/deployment/pipelines.mdx | 2 - .../docs/diagnostics/aspireacanaming001.mdx | 17 ++++- .../docs/diagnostics/aspireacanaming002.mdx | 17 ++++- .../docs/diagnostics/aspireazure001.mdx | 17 ++++- .../docs/diagnostics/aspirecommand001.mdx | 17 ++++- .../docs/diagnostics/aspirecompute002.mdx | 56 ++++++-------- .../docs/diagnostics/aspirecsharpapps001.mdx | 19 ++++- .../aspiredockerfilebuilder001.mdx | 17 ++++- .../docs/diagnostics/aspirefilesystem001.mdx | 17 ++++- .../docs/diagnostics/aspirejavascript001.mdx | 17 ++++- .../content/docs/diagnostics/aspiremcp001.mdx | 17 ++++- .../docs/diagnostics/aspirepipelines001.mdx | 17 ++++- .../docs/diagnostics/aspirepipelines002.mdx | 17 ++++- .../docs/diagnostics/aspirepipelines004.mdx | 17 ++++- .../docs/diagnostics/aspireprobes001.mdx | 17 ++++- .../docs/diagnostics/aspireusersecrets001.mdx | 17 ++++- .../src/content/docs/diagnostics/overview.mdx | 29 ++++---- .../fundamentals/environment-variables.mdx | 4 +- .../get-started/add-aspire-existing-app.mdx | 6 +- .../docs/get-started/resource-mcp-servers.mdx | 18 +++-- .../cloud/azure/configure-container-apps.mdx | 2 +- .../cloud/azure/role-assignments.mdx | 2 - .../docs/integrations/compute/docker.mdx | 8 -- .../integrations/compute/kind/kind-host.mdx | 2 - .../dotnet/csharp-file-based-apps.mdx | 74 +++++++++++-------- .../integrations/dotnet/project-resources.mdx | 4 + .../frameworks/dotnet/dotnet-host.mdx | 1 + .../integrations/frameworks/javascript.mdx | 14 ---- .../src/content/docs/whats-new/aspire-17.mdx | 57 +++++++++++++- 33 files changed, 358 insertions(+), 203 deletions(-) diff --git a/src/frontend/src/content/docs/app-host/withdockerfile.mdx b/src/frontend/src/content/docs/app-host/withdockerfile.mdx index 0c1cbab721..1b5eb182e0 100644 --- a/src/frontend/src/content/docs/app-host/withdockerfile.mdx +++ b/src/frontend/src/content/docs/app-host/withdockerfile.mdx @@ -129,12 +129,6 @@ await pgsql.withPgAdmin(); // Still works because it's still a PostgreSQL resour Use or when you need Aspire to generate a Dockerfile from AppHost code. These APIs are useful when the Dockerfile depends on AppHost configuration, when you want to compose Dockerfile fragments, or when you want to keep multi-stage image build logic near the resource definition. - - `AddDockerfileBuilder` creates a new container resource and configures the generated Dockerfile in one step: @@ -144,7 +138,6 @@ using Aspire.Hosting.ApplicationModel.Docker; var builder = DistributedApplication.CreateBuilder(args); -#pragma warning disable ASPIREDOCKERFILEBUILDER001 builder.AddDockerfileBuilder("frontend", "../frontend", context => { var build = context.Builder.From("node:22-alpine", "build"); @@ -160,7 +153,6 @@ builder.AddDockerfileBuilder("frontend", "../frontend", context => return Task.CompletedTask; }, stage: "runtime"); -#pragma warning restore ASPIREDOCKERFILEBUILDER001 builder.Build().Run(); ``` @@ -207,7 +199,6 @@ using Aspire.Hosting.ApplicationModel.Docker; var builder = DistributedApplication.CreateBuilder(args); -#pragma warning disable ASPIREDOCKERFILEBUILDER001 builder.AddContainer("frontend", "nginx:alpine") .WithDockerfileBuilder("../frontend", context => { @@ -217,7 +208,6 @@ builder.AddContainer("frontend", "nginx:alpine") return Task.CompletedTask; }, stage: "runtime"); -#pragma warning restore ASPIREDOCKERFILEBUILDER001 builder.Build().Run(); ``` diff --git a/src/frontend/src/content/docs/deployment/custom-deployments.mdx b/src/frontend/src/content/docs/deployment/custom-deployments.mdx index 4838e50f59..adf7e34aef 100644 --- a/src/frontend/src/content/docs/deployment/custom-deployments.mdx +++ b/src/frontend/src/content/docs/deployment/custom-deployments.mdx @@ -18,8 +18,10 @@ These APIs give you fine-grained control over the image building process and pro diff --git a/src/frontend/src/content/docs/deployment/docker-compose.mdx b/src/frontend/src/content/docs/deployment/docker-compose.mdx index 96af1a9fcc..7d6091e020 100644 --- a/src/frontend/src/content/docs/deployment/docker-compose.mdx +++ b/src/frontend/src/content/docs/deployment/docker-compose.mdx @@ -222,12 +222,6 @@ If you commit these artifacts to source control, you can check that they stay in Docker Compose deployments can build images from Dockerfiles that are generated by your AppHost. Use to create a new container resource from a generated Dockerfile, or to replace the image for an existing container resource with a generated Dockerfile build. - - ```csharp title="AppHost.cs" @@ -237,7 +231,6 @@ var builder = DistributedApplication.CreateBuilder(args); builder.AddDockerComposeEnvironment("env"); -#pragma warning disable ASPIREDOCKERFILEBUILDER001 builder.AddDockerfileBuilder("frontend", "../frontend", context => { var build = context.Builder.From("node:22-alpine", "build"); @@ -253,7 +246,6 @@ builder.AddDockerfileBuilder("frontend", "../frontend", context => return Task.CompletedTask; }, stage: "runtime"); -#pragma warning restore ASPIREDOCKERFILEBUILDER001 builder.Build().Run(); ``` diff --git a/src/frontend/src/content/docs/deployment/javascript-apps.mdx b/src/frontend/src/content/docs/deployment/javascript-apps.mdx index cb81f93ead..f3eb86baae 100644 --- a/src/frontend/src/content/docs/deployment/javascript-apps.mdx +++ b/src/frontend/src/content/docs/deployment/javascript-apps.mdx @@ -35,10 +35,6 @@ To deploy a JavaScript app, choose which resource owns the public HTTP surface i - Use a JavaScript publish method when the JavaScript app resource should become the deployed static website or Node.js server. - Use `AddNextJsApp(...)` for a Next.js app that publishes as a standalone Next.js server. -:::caution[Experimental] -The JavaScript app resource publish methods and `AddNextJsApp` are marked `[Experimental]` and require suppressing the `ASPIREJAVASCRIPT001` diagnostic. -::: - If you only add a Vite or JavaScript app and reference backend services, Aspire still needs one of these production hosting patterns to know who serves requests in deployment. During publish or deploy, Aspire validates that build-only containers are either consumed by another resource through `PublishWithContainerFiles(...)` or `PublishWithStaticFiles(...)`, or converted into a deployable JavaScript resource with a JavaScript publish method. An unconsumed build-only container does not participate in deployment.