Repository navigation
[docs] Remove obsolete ASPIREAZURE001 suppression from role-assignments example - #1851
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
…s example Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
docs-pr-reviewer report — [partial — phase A: all extracted claims evaluated; phase B: not run (docs site was not served in this automated run)]Recommendation: approve Source used: Phase A — claims
Phase B — doc-testerNot run; rendering of the changed pages is not browser-checked. 🤖 Posted by aspire.dev - squad (AI Agent) |
There was a problem hiding this comment.
🔵 Needs a closer look
Confirming that AzureEnvironmentResource no longer requires ASPIREAZURE001 on release/17.0 requires upstream source or compiler validation, neither of which is available in this restricted snapshot.
No open issues 🎉
What changed in this PR
Updates the Azure role-assignment documentation to reflect the stabilization of AzureEnvironmentResource in Aspire 17.0, as described in microsoft/aspire#20820.
Changes:
- Removes the obsolete
ASPIREAZURE001warning suppression and trailing blank line from the C# pipeline-step example; the remaining sample is unchanged.
| File | Description |
|---|---|
src/frontend/src/content/docs/integrations/cloud/azure/role-assignments.mdx |
Removes the obsolete experimental-API suppression from the example. |
Review effort: Balanced
|
Superseded by #2176, which consolidates the 17.0 retired experimental diagnostics docs with a consistent format ( |
## Summary <!-- Describe what this pull request changes and why. --> Consolidates the retired experimental diagnostic documentation for Aspire 17.0, superseding the individual PRs against `release/17.0`. - Marks 14 diagnostic pages as retired in 17.0, retaining their historical content and guidance for removing suppressions. - Updates the diagnostics overview and the 17.0 release notes, including `ASPIREDENO001` and `ASPIRECONNECTIONSTRINGS001`, which don't have dedicated pages. - Explains that `ASPIRECOMPUTE002` was only partially graduated: endpoint-mapping contracts are stable, while persistent-volume APIs remain experimental. - Removes retired suppressions and experimental cautions from affected guides, while retaining the experimental image-building guidance for `ASPIREPIPELINES003`. - Notes that `ASPIRECSHARPAPPS001` was retired when `AddCSharpApp` became obsolete. The broader migration and ProjectResource v2 guidance is separate in #2180. The retired diagnostic list was checked against `[Experimental("…")]` usages in `microsoft/aspire` between `v13.6.5` and `release/17.0`. Supersedes #1846, #1847, #1851, #1852, #1853, #1854, #1856, #1857, #2127, #2167, #2168, #2169, #2170, #2171. ## Third-party links and affiliations <!-- List any third-party links added or changed by this pull request and disclose any material affiliation with the linked organizations, such as employment, sponsorship, or ownership. Write "None" if this pull request doesn't add or change third-party links. --> None ## Validation <!-- List the checks you ran or explain why validation isn't needed. --> - `git diff --check origin/release/17.0 -- src/frontend/src/content/docs` — passed. - Frontend validation CI — passed; frontend build CI is pending. - Local Astro build and tests were not run; Bun and frontend dependencies were unavailable. --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Documents changes from microsoft/aspire#20820
@mitchdennyTarget branch: Targeting
release/17.0based on the source PR milestone17.0(exact match onmicrosoft/aspire.dev).Why this PR is needed
microsoft/aspire#20820 graduates five core Azure deployment APIs to stable by removing their
[Experimental("ASPIREAZURE001")]attributes:AzureEnvironmentResourceAzurePublishingContextAzureEnvironmentResourceExtensions.AddAzureEnvironmentAzureEnvironmentResourceExtensions.WithLocationAzureEnvironmentResourceExtensions.WithResourceGroupThe PR's "User-facing usage" section confirms that existing Azure environment configuration (
builder.AddAzureEnvironment().WithLocation(...).WithResourceGroup(...)) no longer requires anASPIREAZURE001suppression.A code sample in
integrations/cloud/azure/role-assignments.mdxstill showed#pragma warning disable ASPIREAZURE001 // AzureEnvironmentResource is Experimentalahead of a pipeline-step example that referencesAzureEnvironmentResource.PrepareResourcesStepName. Leaving this in place would incorrectly suggest the suppression is still required.What changed
#pragma warning disable ASPIREAZURE001directive (and its trailing blank line) from the C# code sample inintegrations/cloud/azure/role-assignments.mdx, sinceAzureEnvironmentResourceis no longer experimental.Files modified
src/frontend/src/content/docs/integrations/cloud/azure/role-assignments.mdxNo new pages were created; this is a targeted update to an existing example to keep it accurate after the API graduation.