Skip to content

[docs] Document graduation of user secrets manager APIs to stable - #1854

Closed
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20817-37866849753-1-e73851073bc2bbbe
Closed

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20817-37866849753-1-e73851073bc2bbbe

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#20817

@mitchdenny

Target branch

Targeting release/17.0 based on the source PR milestone 17.0 (exact match on microsoft/aspire.dev).

Why this is needed

microsoft/aspire#20817 graduates the ASPIREUSERSECRETS001 API family (IUserSecretsManager and IDistributedApplicationBuilder.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 an ASPIREUSERSECRETS001 suppression, 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 describe ASPIREUSERSECRETS001 as a pre-17.0 diagnostic, following the same pattern used for ASPIREACADOMAINS001 when ConfigureCustomDomain graduated. Added a :::note callout 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-testing guidance for doc-only edits. Reviewed the edited files for Markdown formatting (no consecutive blank lines, fenced code blocks with language identifiers) and confirmed the seoTitle stays within the SEO length guard.

Generated by PR Documentation Check for #20817 · copilot · auto · 123.7 AIC · ⌖ 10.7 AIC · ⊞ 20.4K · ◷

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>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Oct 9, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1854. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1854 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Copy link
Copy Markdown
Member

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: microsoft/aspire main via merged source PR microsoft/aspire#20817 (docs PR targets release/17.0; no matching branch checked).
PR status: draft, mergeable, opened 2026-10-08 (not stale)

Phase A — claims

  • ✅ verified: [Experimental("ASPIREUSERSECRETS001")] removed from IUserSecretsManager and IDistributedApplicationBuilder.UserSecretsManager.
  • ⚠️ nuance (not re-verified): the what's-new claim that persistence semantics, path resolution and TryDeleteSecret default are unchanged; the source PR only removes attributes/pragmas.

Phase B — doc-tester

Not run; rendering of the changed pages is not browser-checked.

🤖 Posted by aspire.dev - squad (AI Agent)

@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review November 13, 2026 14:58
Copilot AI balanced review requested due to automatic review settings November 13, 2026 14:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 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 ASPIREUSERSECRETS001 as 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

@maddymontaquila

Copy link
Copy Markdown
Contributor

Superseded by #2176, which consolidates the 17.0 retired experimental diagnostics docs with a consistent format (Retired in: 17.0 badge and note, overview table, and a single What's new section).

Maddy Montaquila (maddymontaquila) added a commit that referenced this pull request Nov 16, 2026
## 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants