Repository navigation
[docs] Document graduation of user secrets manager APIs to stable - #1854
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Document that IUserSecretsManager and IDistributedApplicationBuilder.UserSecretsManager have graduated from experimental to stable in Aspire 17.0, following microsoft/aspire#20817. - Update ASPIREUSERSECRETS001 diagnostic page to reflect the graduation, matching the pattern used for ASPIREACADOMAINS001. - Add a What's new in Aspire 17.0 entry announcing the graduation. 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
Unavailable rendering and C# sample validation, combined with upstream fetch timeouts, left the graduation and unchanged-behavior claims requiring human confirmation.
No open issues 🎉
What changed in this PR
Documents the graduation of user secrets manager APIs to stable in Aspire 17.0, aligning the diagnostic guidance and release notes with the upstream change.
Changes:
- Marks
ASPIREUSERSECRETS001as a pre-17.0 diagnostic and explains when suppressions can be removed. - Adds a release-note section with a usage example and confirms that API signatures, defaults, and behavior are unchanged.
| File | Description |
|---|---|
src/frontend/src/content/docs/whats-new/aspire-17.mdx |
Announces the stable APIs with an example and diagnostic-page link. |
src/frontend/src/content/docs/diagnostics/aspireusersecrets001.mdx |
Updates diagnostic history and version-specific suppression guidance. |
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#20817
@mitchdennyTarget branch
Targeting
release/17.0based on the source PR milestone17.0(exact match onmicrosoft/aspire.dev).Why this is needed
microsoft/aspire#20817 graduates the
ASPIREUSERSECRETS001API family (IUserSecretsManagerandIDistributedApplicationBuilder.UserSecretsManager) from experimental to stable, removing all experimental attributes and suppression directives. This is an attribute-only change — signatures, defaults, and behavior are unchanged.The PR body's "User-facing usage" section shows that existing code (
builder.UserSecretsManager) no longer needs anASPIREUSERSECRETS001suppression, which is a direct, user-visible documentation gap: the diagnostics page still described these APIs as experimental.What changed
src/frontend/src/content/docs/diagnostics/aspireusersecrets001.mdx(updated): Reworded the page to describeASPIREUSERSECRETS001as a pre-17.0 diagnostic, following the same pattern used forASPIREACADOMAINS001whenConfigureCustomDomaingraduated. Added a:::notecallout announcing the graduation, changed the example to "Before Aspire 17.0, the following code generated...", and updated "To correct this warning" to state that Aspire 17.0+ consumers don't need to suppress the diagnostic.src/frontend/src/content/docs/whats-new/aspire-17.mdx(updated): Added a new "🔐 User secrets manager APIs are stable" section before the breaking-changes section, with a short code sample and a cross-link back to the diagnostic page.No new pages were created; both existing pages were updated in place.
Validation
Documentation-only change; no test commands were run per the
pr-testingguidance for doc-only edits. Reviewed the edited files for Markdown formatting (no consecutive blank lines, fenced code blocks with language identifiers) and confirmed theseoTitlestays within the SEO length guard.