Skip to content

Commit de2d81a

Browse files
CopilotcaptainsafiaIEvangelist
authored
Add documentation for ASPIREPIPELINES001, ASPIREPIPELINES002, and ASPIREPIPELINES003 diagnostics (#5359)
* Initial plan * Add documentation for three new pipeline-related diagnostics Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> * Fix ms.date to reflect current date in diagnostic documentation Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> * Update diagnostic codes to use ASPIREPIPELINES001-003 instead of mixed naming scheme Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> * Add ASPIREPIPELINES001-003 diagnostics to TOC Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
1 parent 24edde9 commit de2d81a

File tree

5 files changed

+181
-0
lines changed

5 files changed

+181
-0
lines changed

‎docs/diagnostics/aspirepipelines001.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Compiler Error ASPIREPIPELINES001
3+
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.
4+
ms.date: 10/27/2025
5+
f1_keywords:
6+
- "ASPIREPIPELINES001"
7+
helpviewer_keywords:
8+
- "ASPIREPIPELINES001"
9+
ai-usage: ai-generated
10+
---
11+
12+
# Compiler Error ASPIREPIPELINES001
13+
14+
**Version introduced:** 13.0
15+
16+
> Pipeline infrastructure APIs are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed.
17+
18+
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.
19+
20+
Pipeline infrastructure APIs are considered experimental and are expected to change in future updates.
21+
22+
## APIs affected
23+
24+
This diagnostic applies to the following pipeline infrastructure APIs:
25+
26+
- `IPipelineActivityReporter` - Interface for reporting pipeline activities
27+
- `IReportingStep` - Interface for managing pipeline steps
28+
- `IReportingTask` - Interface for managing tasks within a step
29+
- `CompletionState` - Enumeration for tracking completion status
30+
- `PublishingContext` - Context for publishing operations
31+
- `PublishingCallbackAnnotation` - Annotation for publishing callbacks
32+
- Related extension methods and implementations
33+
34+
## To correct this error
35+
36+
Suppress the error with one of the following methods:
37+
38+
- Set the severity of the rule in the _.editorconfig_ file.
39+
40+
```ini
41+
[*.{cs,vb}]
42+
dotnet_diagnostic.ASPIREPIPELINES001.severity = none
43+
```
44+
45+
For more information about editor config files, see [Configuration files for code analysis rules](/dotnet/fundamentals/code-analysis/configuration-files).
46+
47+
- Add the following `PropertyGroup` to your project file:
48+
49+
```xml
50+
<PropertyGroup>
51+
<NoWarn>$(NoWarn);ASPIREPIPELINES001</NoWarn>
52+
</PropertyGroup>
53+
```
54+
55+
- Suppress in code with the `#pragma warning disable ASPIREPIPELINES001` directive.

‎docs/diagnostics/aspirepipelines002.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Compiler Error ASPIREPIPELINES002
3+
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.
4+
ms.date: 10/28/2025
5+
f1_keywords:
6+
- "ASPIREPIPELINES002"
7+
helpviewer_keywords:
8+
- "ASPIREPIPELINES002"
9+
ai-usage: ai-generated
10+
---
11+
12+
# Compiler Error ASPIREPIPELINES002
13+
14+
**Version introduced:** 13.0
15+
16+
> Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed.
17+
18+
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.
19+
20+
Deployment state manager APIs are considered experimental and are expected to change in future updates.
21+
22+
## APIs affected
23+
24+
This diagnostic applies to the following deployment state manager APIs:
25+
26+
- `IDeploymentStateManager` - Interface for managing deployment state
27+
- Deployment state manager implementations
28+
- `Deploy` property in `PublishingOptions`
29+
- `ClearCache` property in `PublishingOptions`
30+
- `Step` property in `PublishingOptions`
31+
- `DeployingCallbackAnnotation` - Annotation for deploying callbacks
32+
- Azure provisioning context providers
33+
- Related extension methods and implementations
34+
35+
## To correct this error
36+
37+
Suppress the error with one of the following methods:
38+
39+
- Set the severity of the rule in the _.editorconfig_ file.
40+
41+
```ini
42+
[*.{cs,vb}]
43+
dotnet_diagnostic.ASPIREPIPELINES002.severity = none
44+
```
45+
46+
For more information about editor config files, see [Configuration files for code analysis rules](/dotnet/fundamentals/code-analysis/configuration-files).
47+
48+
- Add the following `PropertyGroup` to your project file:
49+
50+
```xml
51+
<PropertyGroup>
52+
<NoWarn>$(NoWarn);ASPIREPIPELINES002</NoWarn>
53+
</PropertyGroup>
54+
```
55+
56+
- Suppress in code with the `#pragma warning disable ASPIREPIPELINES002` directive.

‎docs/diagnostics/aspirepipelines003.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Compiler Error ASPIREPIPELINES003
3+
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.
4+
ms.date: 10/28/2025
5+
f1_keywords:
6+
- "ASPIREPIPELINES003"
7+
helpviewer_keywords:
8+
- "ASPIREPIPELINES003"
9+
ai-usage: ai-generated
10+
---
11+
12+
# Compiler Error ASPIREPIPELINES003
13+
14+
**Version introduced:** 13.0
15+
16+
> Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed.
17+
18+
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.
19+
20+
Container image build APIs are considered experimental and are expected to change in future updates.
21+
22+
## APIs affected
23+
24+
This diagnostic applies to the following container image build APIs:
25+
26+
- `IResourceContainerImageBuilder` - Interface for building container images
27+
- `ContainerBuildOptions` - Options for configuring container builds
28+
- `ContainerImageFormat` - Enumeration for specifying image format
29+
- `ContainerTargetPlatform` - Type for specifying target platform
30+
- `ContainerTargetPlatformExtensions` - Extension methods for platform configuration
31+
- Docker and Podman container runtime implementations
32+
- Related extension methods and implementations
33+
34+
## To correct this error
35+
36+
Suppress the error with one of the following methods:
37+
38+
- Set the severity of the rule in the _.editorconfig_ file.
39+
40+
```ini
41+
[*.{cs,vb}]
42+
dotnet_diagnostic.ASPIREPIPELINES003.severity = none
43+
```
44+
45+
For more information about editor config files, see [Configuration files for code analysis rules](/dotnet/fundamentals/code-analysis/configuration-files).
46+
47+
- Add the following `PropertyGroup` to your project file:
48+
49+
```xml
50+
<PropertyGroup>
51+
<NoWarn>$(NoWarn);ASPIREPIPELINES003</NoWarn>
52+
</PropertyGroup>
53+
```
54+
55+
- Suppress in code with the `#pragma warning disable ASPIREPIPELINES003` directive.

‎docs/diagnostics/overview.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ The following table lists the possible MSBuild and .NET Analyzer warnings and er
2424
| [`ASPIRECOMPUTE001`](aspirecompute001.md) | (Experimental) Error | <span id="ASPIRECOMPUTE001"></span> Compute related types and members are for evaluation purposes only and is subject to change or removal in future updates. |
2525
| [`ASPIRECOSMOSDB001`](aspirecosmosdb001.md) | (Experimental) Error | <span id="ASPIRECOSMOSDB001"></span> `RunAsPreviewEmulator` is for evaluation purposes only and is subject to change or removal in future updates. |
2626
| [`ASPIREHOSTINGPYTHON001`](aspirehostingpython001.md) | (Experimental) Error | <span id="ASPIREHOSTINGPYTHON001"></span> `AddPythonApp` is for evaluation purposes only and is subject to change or removal in future updates. |
27+
| [`ASPIREPIPELINES001`](aspirepipelines001.md) | (Experimental) Error | <span id="ASPIREPIPELINES001"></span> Pipeline infrastructure APIs are for evaluation purposes only and are subject to change or removal in future updates. |
28+
| [`ASPIREPIPELINES002`](aspirepipelines002.md) | (Experimental) Error | <span id="ASPIREPIPELINES002"></span> Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. |
29+
| [`ASPIREPIPELINES003`](aspirepipelines003.md) | (Experimental) Error | <span id="ASPIREPIPELINES003"></span> Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. |
2730
| [`ASPIREPROXYENDPOINTS001`](aspireproxyendpoints001.md) | (Experimental) Error | <span id="ASPIREPROXYENDPOINTS001"></span> ProxyEndpoint members are for evaluation purposes only and are subject to change or removal in future updates. |
2831
| [`ASPIREPUBLISHERS001`](aspirepublishers001.md) | Error | <span id="ASPIREPUBLISHERS001"></span> Publishers are for evaluation purposes only and are subject to change or removal in future updates. |
2932

‎docs/toc.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,12 @@ items:
588588
href: diagnostics/aspirecosmosdb001.md
589589
- name: ASPIREHOSTINGPYTHON001
590590
href: diagnostics/aspirehostingpython001.md
591+
- name: ASPIREPIPELINES001
592+
href: diagnostics/aspirepipelines001.md
593+
- name: ASPIREPIPELINES002
594+
href: diagnostics/aspirepipelines002.md
595+
- name: ASPIREPIPELINES003
596+
href: diagnostics/aspirepipelines003.md
591597
- name: ASPIREPROXYENDPOINTS001
592598
href: diagnostics/aspireproxyendpoints001.md
593599
- name: ASPIREPUBLISHERS001
@@ -626,6 +632,12 @@ items:
626632
href: diagnostics/aspireproxyendpoints001.md
627633
- name: Hosting Python apps
628634
href: diagnostics/aspirehostingpython001.md
635+
- name: Pipeline infrastructure APIs are experimental
636+
href: diagnostics/aspirepipelines001.md
637+
- name: Deployment state manager APIs are experimental
638+
href: diagnostics/aspirepipelines002.md
639+
- name: Container image build APIs are experimental
640+
href: diagnostics/aspirepipelines003.md
629641
- name: Publishing APIs are experimental
630642
href: diagnostics/aspirepublishers001.md
631643
- name: Publishing to Azure APIs are experimental

0 commit comments

Comments
 (0)