Repository navigation
[docs] Connection-string naming metadata is now stable - #2167
Closed
aspire-repo-bot[bot] wants to merge 2 commits into
Closed
aspire-repo-bot[bot] wants to merge 2 commits into
aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
4 of 14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
…iagnostic - Scope the stability statement to Aspire 17.0, tell upgraded projects to remove ASPIRECONNECTIONSTRINGS001 suppressions, and note that 13.6 still reports it. - Warn that a `with` copy of ConnectionStringEnvironmentVariableNames doesn't recompute the physical names, and point to Create for a consistent set. - Add a diagnostics page for ASPIRECONNECTIONSTRINGS001 (introduced in 13.6, removed in 17.0) so the aka.ms help link emitted by 13.6 resolves, plus the matching overview row and sidebar entry.
Contributor
|
Superseded by #2176, which consolidates the 17.0 retired experimental diagnostics docs with a consistent format ( |
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents changes from microsoft/aspire#22161
Author:
@maddymontaquila(source PR author; original API by@sebastienros)Targeting
release/17.0based on the source PR milestone17.0(target_resolution:exact_match).Why
The source PR graduates
ConnectionStringEnvironmentVariableNamesandConnectionStringReference.EnvironmentVariableNamesfrom experimental and retiresASPIRECONNECTIONSTRINGS001. The docs still described them as experimental.Changes
src/frontend/src/content/docs/fundamentals/environment-variables.mdx: replaced the experimental caution with a note that the APIs are stable, the diagnostic is retired, and the record properties keepinitaccessors (withcopies don't recompute other properties).No new pages.