diff --git a/docs/diagnostics/aspirepipelines001.md b/docs/diagnostics/aspirepipelines001.md new file mode 100644 index 0000000000..c4f92ce0cb --- /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: 10/27/2025 +f1_keywords: + - "ASPIREPIPELINES001" +helpviewer_keywords: + - "ASPIREPIPELINES001" +ai-usage: ai-generated +--- + +# Compiler Error ASPIREPIPELINES001 + +**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. + +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/aspirepipelines002.md b/docs/diagnostics/aspirepipelines002.md new file mode 100644 index 0000000000..3a037f7c0d --- /dev/null +++ b/docs/diagnostics/aspirepipelines002.md @@ -0,0 +1,56 @@ +--- +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: + - "ASPIREPIPELINES002" +helpviewer_keywords: + - "ASPIREPIPELINES002" +ai-usage: ai-generated +--- + +# Compiler Error ASPIREPIPELINES002 + +**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 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. + +## 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` +- `DeployingCallbackAnnotation` - Annotation for deploying callbacks +- 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.ASPIREPIPELINES002.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);ASPIREPIPELINES002 + + ``` + +- Suppress in code with the `#pragma warning disable ASPIREPIPELINES002` directive. diff --git a/docs/diagnostics/aspirepipelines003.md b/docs/diagnostics/aspirepipelines003.md new file mode 100644 index 0000000000..e6722b0660 --- /dev/null +++ b/docs/diagnostics/aspirepipelines003.md @@ -0,0 +1,55 @@ +--- +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: + - "ASPIREPIPELINES003" +helpviewer_keywords: + - "ASPIREPIPELINES003" +ai-usage: ai-generated +--- + +# Compiler Error ASPIREPIPELINES003 + +**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 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. + +## 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.ASPIREPIPELINES003.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);ASPIREPIPELINES003 + + ``` + +- Suppress in code with the `#pragma warning disable ASPIREPIPELINES003` directive. diff --git a/docs/diagnostics/overview.md b/docs/diagnostics/overview.md index d0ae8596e3..1bf32ad861 100644 --- a/docs/diagnostics/overview.md +++ b/docs/diagnostics/overview.md @@ -24,6 +24,9 @@ The following table lists the possible MSBuild and .NET Analyzer warnings and er | [`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. | | [`ASPIREHOSTINGPYTHON001`](aspirehostingpython001.md) | (Experimental) Error | `AddPythonApp` is for evaluation purposes only and is 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. | 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