Skip to content

[docs] Connection-string naming metadata is now stable - #2167

Closed
aspire-repo-bot[bot] wants to merge 2 commits into
release/17.0from
docs/pr-22161-43735033782-1-597186f104c3fc07
Closed

aspire-repo-bot[bot] wants to merge 2 commits into
release/17.0from
docs/pr-22161-43735033782-1-597186f104c3fc07

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#22161

Author: @maddymontaquila (source PR author; original API by @sebastienros)

Targeting release/17.0 based on the source PR milestone 17.0 (target_resolution: exact_match).

Why

The source PR graduates ConnectionStringEnvironmentVariableNames and ConnectionStringReference.EnvironmentVariableNames from experimental and retires ASPIRECONNECTIONSTRINGS001. The docs still described them as experimental.

Changes

  • Updated 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 keep init accessors (with copies don't recompute other properties).

No new pages.

Generated by PR Documentation Check for #22161 · copilot · auto · 24.6 AIC · ⌖ 1.17 AIC · ⊞ 7.4K · ◷

@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Nov 15, 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 #2167. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #2167 artifacts

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.
@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.

2 participants