From ab2e03bc952165ea858acb121b940a752cb75f57 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 27 Oct 2025 23:25:53 +0000 Subject: [PATCH 1/5] Initial plan From 34a44986fa208c91152c60a13a4df6a8af6cb47f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 27 Oct 2025 23:32:39 +0000 Subject: [PATCH 2/5] Add documentation for three new pipeline-related diagnostics Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> --- docs/diagnostics/aspiredeployment001.md | 55 +++++++++++++++++++++++++ docs/diagnostics/aspireimgbuild001.md | 55 +++++++++++++++++++++++++ docs/diagnostics/aspirepipelines001.md | 55 +++++++++++++++++++++++++ docs/diagnostics/overview.md | 3 ++ 4 files changed, 168 insertions(+) create mode 100644 docs/diagnostics/aspiredeployment001.md create mode 100644 docs/diagnostics/aspireimgbuild001.md create mode 100644 docs/diagnostics/aspirepipelines001.md diff --git a/docs/diagnostics/aspiredeployment001.md b/docs/diagnostics/aspiredeployment001.md new file mode 100644 index 0000000000..3aadd7e99a --- /dev/null +++ b/docs/diagnostics/aspiredeployment001.md @@ -0,0 +1,55 @@ +--- +title: Compiler Error ASPIREDEPLOYMENT001 +description: Learn more about compiler Error ASPIREDEPLOYMENT001. Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. +ms.date: 01/28/2025 +f1_keywords: + - "ASPIREDEPLOYMENT001" +helpviewer_keywords: + - "ASPIREDEPLOYMENT001" +ai-usage: ai-generated +--- + +# Compiler Error ASPIREDEPLOYMENT001 + +**Version introduced:** 9.2 + +> Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed. + +Aspire introduced deployment state manager APIs starting in version 9.2. These APIs enable you to manage and persist deployment state information across pipeline executions. The deployment state manager provides functionality for storing, retrieving, and clearing deployment artifacts and metadata, which is essential for incremental deployments and tracking deployment history. + +Deployment state manager APIs are considered experimental and are expected to change in future updates. + +## APIs affected + +This diagnostic applies to the following deployment state manager APIs: + +- `IDeploymentStateManager` - Interface for managing deployment state +- Deployment state manager implementations +- `Deploy` property in `PublishingOptions` +- `ClearCache` property in `PublishingOptions` +- `Step` property in `PublishingOptions` +- Azure provisioning context providers +- Related extension methods and implementations + +## To correct this error + +Suppress the error with one of the following methods: + +- Set the severity of the rule in the _.editorconfig_ file. + + ```ini + [*.{cs,vb}] + dotnet_diagnostic.ASPIREDEPLOYMENT001.severity = none + ``` + + For more information about editor config files, see [Configuration files for code analysis rules](/dotnet/fundamentals/code-analysis/configuration-files). + +- Add the following `PropertyGroup` to your project file: + + ```xml + + $(NoWarn);ASPIREDEPLOYMENT001 + + ``` + +- Suppress in code with the `#pragma warning disable ASPIREDEPLOYMENT001` directive. diff --git a/docs/diagnostics/aspireimgbuild001.md b/docs/diagnostics/aspireimgbuild001.md new file mode 100644 index 0000000000..e3b31b4dc7 --- /dev/null +++ b/docs/diagnostics/aspireimgbuild001.md @@ -0,0 +1,55 @@ +--- +title: Compiler Error ASPIREIMGBUILD001 +description: Learn more about compiler Error ASPIREIMGBUILD001. Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. +ms.date: 01/28/2025 +f1_keywords: + - "ASPIREIMGBUILD001" +helpviewer_keywords: + - "ASPIREIMGBUILD001" +ai-usage: ai-generated +--- + +# Compiler Error ASPIREIMGBUILD001 + +**Version introduced:** 9.2 + +> Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed. + +Aspire introduced container image build APIs starting in version 9.2. These APIs provide functionality for building container images as part of the deployment pipeline. The container image build APIs enable you to configure build options, specify target platforms, select image formats, and integrate with container runtimes like Docker and Podman. + +Container image build APIs are considered experimental and are expected to change in future updates. + +## APIs affected + +This diagnostic applies to the following container image build APIs: + +- `IResourceContainerImageBuilder` - Interface for building container images +- `ContainerBuildOptions` - Options for configuring container builds +- `ContainerImageFormat` - Enumeration for specifying image format +- `ContainerTargetPlatform` - Type for specifying target platform +- `ContainerTargetPlatformExtensions` - Extension methods for platform configuration +- Docker and Podman container runtime implementations +- Related extension methods and implementations + +## To correct this error + +Suppress the error with one of the following methods: + +- Set the severity of the rule in the _.editorconfig_ file. + + ```ini + [*.{cs,vb}] + dotnet_diagnostic.ASPIREIMGBUILD001.severity = none + ``` + + For more information about editor config files, see [Configuration files for code analysis rules](/dotnet/fundamentals/code-analysis/configuration-files). + +- Add the following `PropertyGroup` to your project file: + + ```xml + + $(NoWarn);ASPIREIMGBUILD001 + + ``` + +- Suppress in code with the `#pragma warning disable ASPIREIMGBUILD001` directive. diff --git a/docs/diagnostics/aspirepipelines001.md b/docs/diagnostics/aspirepipelines001.md new file mode 100644 index 0000000000..fa5350db10 --- /dev/null +++ b/docs/diagnostics/aspirepipelines001.md @@ -0,0 +1,55 @@ +--- +title: Compiler Error ASPIREPIPELINES001 +description: Learn more about compiler Error ASPIREPIPELINES001. Pipeline infrastructure APIs are for evaluation purposes only and are subject to change or removal in future updates. +ms.date: 01/28/2025 +f1_keywords: + - "ASPIREPIPELINES001" +helpviewer_keywords: + - "ASPIREPIPELINES001" +ai-usage: ai-generated +--- + +# Compiler Error ASPIREPIPELINES001 + +**Version introduced:** 9.2 + +> Pipeline infrastructure APIs are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed. + +Aspire introduced pipeline infrastructure APIs starting in version 9.2. These APIs provide core functionality for building deployment pipelines, including interfaces and types for pipeline activity reporting, step management, and publishing contexts. Pipeline infrastructure enables you to create custom deployment workflows and track their execution. + +Pipeline infrastructure APIs are considered experimental and are expected to change in future updates. + +## APIs affected + +This diagnostic applies to the following pipeline infrastructure APIs: + +- `IPipelineActivityReporter` - Interface for reporting pipeline activities +- `IReportingStep` - Interface for managing pipeline steps +- `IReportingTask` - Interface for managing tasks within a step +- `CompletionState` - Enumeration for tracking completion status +- `PublishingContext` - Context for publishing operations +- `PublishingCallbackAnnotation` - Annotation for publishing callbacks +- Related extension methods and implementations + +## To correct this error + +Suppress the error with one of the following methods: + +- Set the severity of the rule in the _.editorconfig_ file. + + ```ini + [*.{cs,vb}] + dotnet_diagnostic.ASPIREPIPELINES001.severity = none + ``` + + For more information about editor config files, see [Configuration files for code analysis rules](/dotnet/fundamentals/code-analysis/configuration-files). + +- Add the following `PropertyGroup` to your project file: + + ```xml + + $(NoWarn);ASPIREPIPELINES001 + + ``` + +- Suppress in code with the `#pragma warning disable ASPIREPIPELINES001` directive. diff --git a/docs/diagnostics/overview.md b/docs/diagnostics/overview.md index d0ae8596e3..66c4b20ee5 100644 --- a/docs/diagnostics/overview.md +++ b/docs/diagnostics/overview.md @@ -23,7 +23,10 @@ The following table lists the possible MSBuild and .NET Analyzer warnings and er | [`ASPIREAZURE002`](aspireazure002.md) | (Experimental) Error | Azure Container App Jobs are for evaluation purposes only and are subject to change or removal in future updates. | | [`ASPIRECOMPUTE001`](aspirecompute001.md) | (Experimental) Error | Compute related types and members are for evaluation purposes only and is subject to change or removal in future updates. | | [`ASPIRECOSMOSDB001`](aspirecosmosdb001.md) | (Experimental) Error | `RunAsPreviewEmulator` is for evaluation purposes only and is subject to change or removal in future updates. | +| [`ASPIREDEPLOYMENT001`](aspiredeployment001.md) | (Experimental) Error | Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. | | [`ASPIREHOSTINGPYTHON001`](aspirehostingpython001.md) | (Experimental) Error | `AddPythonApp` is for evaluation purposes only and is subject to change or removal in future updates. | +| [`ASPIREIMGBUILD001`](aspireimgbuild001.md) | (Experimental) Error | Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. | +| [`ASPIREPIPELINES001`](aspirepipelines001.md) | (Experimental) Error | Pipeline infrastructure APIs are for evaluation purposes only and are subject to change or removal in future updates. | | [`ASPIREPROXYENDPOINTS001`](aspireproxyendpoints001.md) | (Experimental) Error | ProxyEndpoint members are for evaluation purposes only and are subject to change or removal in future updates. | | [`ASPIREPUBLISHERS001`](aspirepublishers001.md) | Error | Publishers are for evaluation purposes only and are subject to change or removal in future updates. | From 2afcb1c81fd96d487b64a9c22a5e56b9aeffd002 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 27 Oct 2025 23:34:32 +0000 Subject: [PATCH 3/5] Fix ms.date to reflect current date in diagnostic documentation Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> --- docs/diagnostics/aspiredeployment001.md | 2 +- docs/diagnostics/aspireimgbuild001.md | 2 +- docs/diagnostics/aspirepipelines001.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/diagnostics/aspiredeployment001.md b/docs/diagnostics/aspiredeployment001.md index 3aadd7e99a..d328c8fb87 100644 --- a/docs/diagnostics/aspiredeployment001.md +++ b/docs/diagnostics/aspiredeployment001.md @@ -1,7 +1,7 @@ --- title: Compiler Error ASPIREDEPLOYMENT001 description: Learn more about compiler Error ASPIREDEPLOYMENT001. Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. -ms.date: 01/28/2025 +ms.date: 10/27/2025 f1_keywords: - "ASPIREDEPLOYMENT001" helpviewer_keywords: diff --git a/docs/diagnostics/aspireimgbuild001.md b/docs/diagnostics/aspireimgbuild001.md index e3b31b4dc7..1928a352bd 100644 --- a/docs/diagnostics/aspireimgbuild001.md +++ b/docs/diagnostics/aspireimgbuild001.md @@ -1,7 +1,7 @@ --- title: Compiler Error ASPIREIMGBUILD001 description: Learn more about compiler Error ASPIREIMGBUILD001. Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. -ms.date: 01/28/2025 +ms.date: 10/27/2025 f1_keywords: - "ASPIREIMGBUILD001" helpviewer_keywords: diff --git a/docs/diagnostics/aspirepipelines001.md b/docs/diagnostics/aspirepipelines001.md index fa5350db10..79c47fbc71 100644 --- a/docs/diagnostics/aspirepipelines001.md +++ b/docs/diagnostics/aspirepipelines001.md @@ -1,7 +1,7 @@ --- title: Compiler Error ASPIREPIPELINES001 description: Learn more about compiler Error ASPIREPIPELINES001. Pipeline infrastructure APIs are for evaluation purposes only and are subject to change or removal in future updates. -ms.date: 01/28/2025 +ms.date: 10/27/2025 f1_keywords: - "ASPIREPIPELINES001" helpviewer_keywords: From 5358f9e3185a395d9bde2a79883e8258a56567b8 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 28 Oct 2025 00:21:32 +0000 Subject: [PATCH 4/5] Update diagnostic codes to use ASPIREPIPELINES001-003 instead of mixed naming scheme Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> --- docs/diagnostics/aspirepipelines001.md | 2 +- ...deployment001.md => aspirepipelines002.md} | 23 ++++++++++--------- ...reimgbuild001.md => aspirepipelines003.md} | 22 +++++++++--------- docs/diagnostics/overview.md | 4 ++-- 4 files changed, 26 insertions(+), 25 deletions(-) rename docs/diagnostics/{aspiredeployment001.md => aspirepipelines002.md} (53%) rename docs/diagnostics/{aspireimgbuild001.md => aspirepipelines003.md} (58%) diff --git a/docs/diagnostics/aspirepipelines001.md b/docs/diagnostics/aspirepipelines001.md index 79c47fbc71..c4f92ce0cb 100644 --- a/docs/diagnostics/aspirepipelines001.md +++ b/docs/diagnostics/aspirepipelines001.md @@ -11,7 +11,7 @@ ai-usage: ai-generated # Compiler Error ASPIREPIPELINES001 -**Version introduced:** 9.2 +**Version introduced:** 13.0 > Pipeline infrastructure APIs are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed. diff --git a/docs/diagnostics/aspiredeployment001.md b/docs/diagnostics/aspirepipelines002.md similarity index 53% rename from docs/diagnostics/aspiredeployment001.md rename to docs/diagnostics/aspirepipelines002.md index d328c8fb87..3a037f7c0d 100644 --- a/docs/diagnostics/aspiredeployment001.md +++ b/docs/diagnostics/aspirepipelines002.md @@ -1,21 +1,21 @@ --- -title: Compiler Error ASPIREDEPLOYMENT001 -description: Learn more about compiler Error ASPIREDEPLOYMENT001. Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. -ms.date: 10/27/2025 +title: Compiler Error ASPIREPIPELINES002 +description: Learn more about compiler Error ASPIREPIPELINES002. Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. +ms.date: 10/28/2025 f1_keywords: - - "ASPIREDEPLOYMENT001" + - "ASPIREPIPELINES002" helpviewer_keywords: - - "ASPIREDEPLOYMENT001" + - "ASPIREPIPELINES002" ai-usage: ai-generated --- -# Compiler Error ASPIREDEPLOYMENT001 +# Compiler Error ASPIREPIPELINES002 -**Version introduced:** 9.2 +**Version introduced:** 13.0 > Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed. -Aspire introduced deployment state manager APIs starting in version 9.2. These APIs enable you to manage and persist deployment state information across pipeline executions. The deployment state manager provides functionality for storing, retrieving, and clearing deployment artifacts and metadata, which is essential for incremental deployments and tracking deployment history. +Aspire introduced deployment state manager APIs as part of the pipeline infrastructure starting in version 13.0. These APIs enable you to manage and persist deployment state information across pipeline executions. The deployment state manager provides functionality for storing, retrieving, and clearing deployment artifacts and metadata, which is essential for incremental deployments and tracking deployment history. Deployment state manager APIs are considered experimental and are expected to change in future updates. @@ -28,6 +28,7 @@ This diagnostic applies to the following deployment state manager APIs: - `Deploy` property in `PublishingOptions` - `ClearCache` property in `PublishingOptions` - `Step` property in `PublishingOptions` +- `DeployingCallbackAnnotation` - Annotation for deploying callbacks - Azure provisioning context providers - Related extension methods and implementations @@ -39,7 +40,7 @@ Suppress the error with one of the following methods: ```ini [*.{cs,vb}] - dotnet_diagnostic.ASPIREDEPLOYMENT001.severity = none + dotnet_diagnostic.ASPIREPIPELINES002.severity = none ``` For more information about editor config files, see [Configuration files for code analysis rules](/dotnet/fundamentals/code-analysis/configuration-files). @@ -48,8 +49,8 @@ Suppress the error with one of the following methods: ```xml - $(NoWarn);ASPIREDEPLOYMENT001 + $(NoWarn);ASPIREPIPELINES002 ``` -- Suppress in code with the `#pragma warning disable ASPIREDEPLOYMENT001` directive. +- Suppress in code with the `#pragma warning disable ASPIREPIPELINES002` directive. diff --git a/docs/diagnostics/aspireimgbuild001.md b/docs/diagnostics/aspirepipelines003.md similarity index 58% rename from docs/diagnostics/aspireimgbuild001.md rename to docs/diagnostics/aspirepipelines003.md index 1928a352bd..e6722b0660 100644 --- a/docs/diagnostics/aspireimgbuild001.md +++ b/docs/diagnostics/aspirepipelines003.md @@ -1,21 +1,21 @@ --- -title: Compiler Error ASPIREIMGBUILD001 -description: Learn more about compiler Error ASPIREIMGBUILD001. Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. -ms.date: 10/27/2025 +title: Compiler Error ASPIREPIPELINES003 +description: Learn more about compiler Error ASPIREPIPELINES003. Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. +ms.date: 10/28/2025 f1_keywords: - - "ASPIREIMGBUILD001" + - "ASPIREPIPELINES003" helpviewer_keywords: - - "ASPIREIMGBUILD001" + - "ASPIREPIPELINES003" ai-usage: ai-generated --- -# Compiler Error ASPIREIMGBUILD001 +# Compiler Error ASPIREPIPELINES003 -**Version introduced:** 9.2 +**Version introduced:** 13.0 > Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed. -Aspire introduced container image build APIs starting in version 9.2. These APIs provide functionality for building container images as part of the deployment pipeline. The container image build APIs enable you to configure build options, specify target platforms, select image formats, and integrate with container runtimes like Docker and Podman. +Aspire introduced container image build APIs as part of the pipeline infrastructure starting in version 13.0. These APIs provide functionality for building container images as part of the deployment pipeline. The container image build APIs enable you to configure build options, specify target platforms, select image formats, and integrate with container runtimes like Docker and Podman. Container image build APIs are considered experimental and are expected to change in future updates. @@ -39,7 +39,7 @@ Suppress the error with one of the following methods: ```ini [*.{cs,vb}] - dotnet_diagnostic.ASPIREIMGBUILD001.severity = none + dotnet_diagnostic.ASPIREPIPELINES003.severity = none ``` For more information about editor config files, see [Configuration files for code analysis rules](/dotnet/fundamentals/code-analysis/configuration-files). @@ -48,8 +48,8 @@ Suppress the error with one of the following methods: ```xml - $(NoWarn);ASPIREIMGBUILD001 + $(NoWarn);ASPIREPIPELINES003 ``` -- Suppress in code with the `#pragma warning disable ASPIREIMGBUILD001` directive. +- Suppress in code with the `#pragma warning disable ASPIREPIPELINES003` directive. diff --git a/docs/diagnostics/overview.md b/docs/diagnostics/overview.md index 66c4b20ee5..1bf32ad861 100644 --- a/docs/diagnostics/overview.md +++ b/docs/diagnostics/overview.md @@ -23,10 +23,10 @@ The following table lists the possible MSBuild and .NET Analyzer warnings and er | [`ASPIREAZURE002`](aspireazure002.md) | (Experimental) Error | Azure Container App Jobs are for evaluation purposes only and are subject to change or removal in future updates. | | [`ASPIRECOMPUTE001`](aspirecompute001.md) | (Experimental) Error | Compute related types and members are for evaluation purposes only and is subject to change or removal in future updates. | | [`ASPIRECOSMOSDB001`](aspirecosmosdb001.md) | (Experimental) Error | `RunAsPreviewEmulator` is for evaluation purposes only and is subject to change or removal in future updates. | -| [`ASPIREDEPLOYMENT001`](aspiredeployment001.md) | (Experimental) Error | Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. | | [`ASPIREHOSTINGPYTHON001`](aspirehostingpython001.md) | (Experimental) Error | `AddPythonApp` is for evaluation purposes only and is subject to change or removal in future updates. | -| [`ASPIREIMGBUILD001`](aspireimgbuild001.md) | (Experimental) Error | Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. | | [`ASPIREPIPELINES001`](aspirepipelines001.md) | (Experimental) Error | Pipeline infrastructure APIs are for evaluation purposes only and are subject to change or removal in future updates. | +| [`ASPIREPIPELINES002`](aspirepipelines002.md) | (Experimental) Error | Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. | +| [`ASPIREPIPELINES003`](aspirepipelines003.md) | (Experimental) Error | Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. | | [`ASPIREPROXYENDPOINTS001`](aspireproxyendpoints001.md) | (Experimental) Error | ProxyEndpoint members are for evaluation purposes only and are subject to change or removal in future updates. | | [`ASPIREPUBLISHERS001`](aspirepublishers001.md) | Error | Publishers are for evaluation purposes only and are subject to change or removal in future updates. | From 706911d57fb65c7d5624e9bf15e0cbf60524b39c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 28 Oct 2025 18:26:33 +0000 Subject: [PATCH 5/5] Add ASPIREPIPELINES001-003 diagnostics to TOC Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --- docs/toc.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/toc.yml b/docs/toc.yml index ae30c9bd56..c50f32ac23 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -588,6 +588,12 @@ items: href: diagnostics/aspirecosmosdb001.md - name: ASPIREHOSTINGPYTHON001 href: diagnostics/aspirehostingpython001.md + - name: ASPIREPIPELINES001 + href: diagnostics/aspirepipelines001.md + - name: ASPIREPIPELINES002 + href: diagnostics/aspirepipelines002.md + - name: ASPIREPIPELINES003 + href: diagnostics/aspirepipelines003.md - name: ASPIREPROXYENDPOINTS001 href: diagnostics/aspireproxyendpoints001.md - name: ASPIREPUBLISHERS001 @@ -626,6 +632,12 @@ items: href: diagnostics/aspireproxyendpoints001.md - name: Hosting Python apps href: diagnostics/aspirehostingpython001.md + - name: Pipeline infrastructure APIs are experimental + href: diagnostics/aspirepipelines001.md + - name: Deployment state manager APIs are experimental + href: diagnostics/aspirepipelines002.md + - name: Container image build APIs are experimental + href: diagnostics/aspirepipelines003.md - name: Publishing APIs are experimental href: diagnostics/aspirepublishers001.md - name: Publishing to Azure APIs are experimental