Skip to content

[docs] Graduate ASPIREPIPELINES002 deployment state APIs to stable in 17.0 #1856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
aspire-repo-bot wants to merge 1 commit into
base: release/17.0
Choose a base branch
from
+26 −2
Draft

[docs] Graduate ASPIREPIPELINES002 deployment state APIs to stable in 17.0 #1856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/frontend/src/content/docs/diagnostics/aspirepipelines002.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ Aspire introduced deployment state manager APIs as part of the pipeline infrastr

Deployment state manager APIs are considered experimental and are expected to change in future updates.

:::note
In Aspire 17.0, `IDeploymentStateManager` and `DeploymentStateSection` graduated from experimental and no longer trigger this diagnostic.
:::

## APIs affected

This diagnostic applies to the following deployment state manager APIs:
Expand All @@ -30,7 +34,9 @@ This diagnostic applies to the following deployment state manager APIs:

## To correct this error

Suppress the error with one of the following methods:
If you use Aspire 17.0 or later, you don't need to suppress this diagnostic and can remove any existing `ASPIREPIPELINES002` suppressions.

If you use an Aspire version earlier than 17.0, suppress the diagnostic with one of the following methods:

- Set the severity of the rule in the _.editorconfig_ file.

Expand Down
2 changes: 1 addition & 1 deletion src/frontend/src/content/docs/diagnostics/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The following table lists the possible MSBuild and analyzer warnings and errors
| [ASPIREMCP001](/diagnostics/aspiremcp001/) | (Experimental) Warning | <abbr title="Model Context Protocol" data-tooltip-placement="top">MCP</abbr> server types and members are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREPERSISTENCE001](/diagnostics/aspirepersistence001/) | (Experimental) Error | Resource lifetime types and members are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREPIPELINES001](/diagnostics/aspirepipelines001/) | (Experimental) Error | Pipeline infrastructure APIs are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREPIPELINES002](/diagnostics/aspirepipelines002/) | (Experimental) Error | Deployment state manager APIs are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREPIPELINES002](/diagnostics/aspirepipelines002/) | (Experimental) Error | Graduated to stable in Aspire 17.0. `IDeploymentStateManager` and `DeploymentStateSection` no longer require suppressing this diagnostic. |
| [ASPIREPIPELINES003](/diagnostics/aspirepipelines003/) | (Experimental) Error | Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREPIPELINES004](/diagnostics/aspirepipelines004/) | (Experimental) Warning | Type is for evaluation purposes only and is subject to change or removal in future updates. |
| [ASPIREPOSTGRES001](/diagnostics/aspirepostgres001/) | (Experimental) Warning | PostgreSQL MCP integration is for evaluation purposes only and is subject to change or removal in future updates. |
Expand Down
18 changes: 18 additions & 0 deletions src/frontend/src/content/docs/whats-new/aspire-17.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,21 @@ The service registration calls, `AddRabbitMQClient` and `AddMongoDBClient`, rema
current client setup guidance. For the removal details, see
[microsoft/aspire#20608](https://github.com/microsoft/aspire/pull/20608).
</LearnMore>

## 🚀 Pipelines and deployment

### Deployment state manager APIs are stable

The deployment state manager APIs — `IDeploymentStateManager` and `DeploymentStateSection` — have graduated to stable. You can use them to store, retrieve, and clear deployment artifacts and metadata across pipeline executions without suppressing `ASPIREPIPELINES002`.

```csharp
var section = await stateManager.AcquireSectionAsync("Parameters");
section.Data["key1"] = "value1";
await stateManager.SaveSectionAsync(section);
```

All signatures, defaults, and persistence behavior are unchanged from the experimental release.

<LearnMore>
For diagnostic details, see [ASPIREPIPELINES002](/diagnostics/aspirepipelines002/).
</LearnMore>
Loading