Skip to content

[docs] Document ASPIREPROBES001 graduation to stable in Aspire 17.0 - #1847

Closed
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20813-37782684782-1-49f3278140e7a922
Closed

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20813-37782684782-1-49f3278140e7a922

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#20813

@mitchdenny

Target branch

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

Why this PR is needed

microsoft/aspire#20813 graduates the HTTP probe APIs (WithHttpProbe, ProbeType, ProbeAnnotation, EndpointProbeAnnotation, IResourceWithProbes) from experimental to stable, removing the [Experimental("ASPIREPROBES001")] attribute and all related suppressions across hosting resources, Kubernetes/ACA/App Service/Front Door consumers, and tests. This is an attribute-only change — all signatures, defaults, overloads, runtime semantics, health-check behavior, and deployment output are preserved.

The PR body's User-facing usage section demonstrates that existing WithHttpProbe calls now compile without suppressing ASPIREPROBES001, which is a direct, documented behavior change that the existing ASPIREPROBES001 docs page did not reflect.

Triggered signals from the automated check:

  • pr_body_has_user_facing_section — the PR body includes a "User-facing usage" section showing WithHttpProbe(ProbeType.Liveness, "/health") now compiling without a suppression.
  • pr_body_has_cli_flag_mention — this matched on --no-build / --filter-not-trait in the PR's validation command table, which are test-runner flags, not a new CLI surface. No CLI changes are present in this PR, so no CLI docs were touched.

What changed

  • src/frontend/src/content/docs/diagnostics/aspireprobes001.mdx: Added a :::note[Graduated in Aspire 17.0] callout (matching the pattern used for ASPIREDOTNETPROJECT001 and ASPIREACADOMAINS001), reworded the description/lead-in to past tense ("Before Aspire 17.0, ..."), updated frontmatter description/seoTitle, and added a "To correct this warning" section instructing users to upgrade and remove suppressions, while preserving the existing suppression instructions for users on earlier versions.
  • src/frontend/src/content/docs/diagnostics/overview.mdx: Updated the ASPIREPROBES001 table row from (Experimental) Warning to Warning, with a description noting the Aspire 17.0 graduation.

Both are updates to existing pages; no new pages were created.

Generated by PR Documentation Check for #20813 · copilot · auto · 81 AIC · ⌖ 10.3 AIC · ⊞ 20.4K · ◷

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 8, 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 #1847. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1847 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#20813 (docs PR targets release/17.0; no matching branch checked).
PR status: draft, mergeable, opened 2026-10-08 (not stale at 30 days)

Phase A — claims

  • ✅ verified: [Experimental("ASPIREPROBES001")] removed from IResourceWithProbes, the three ProbeAnnotation.cs types and the WithHttpProbe overloads in ResourceBuilderExtensions.cs; matching pragma suppressions removed throughout.
  • ✅ verified: overview table row and rewritten diagnostic page are consistent with graduation.

Phase B — doc-tester

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

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

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

The core Aspire 17.0 graduation and unchanged-behavior claims could not be independently verified because source evidence was unavailable and review constraints prevented compilation and rendered-page validation.

No open issues 🎉

What changed in this PR

Documents the HTTP probe APIs’ graduation from experimental to stable in Aspire 17.0, updating the existing diagnostic guidance without changing runtime behavior.

Changes:

  • Adds graduation guidance and instructions to remove ASPIREPROBES001 suppressions after upgrading, while retaining suppression instructions for earlier versions.
  • Updates the diagnostic overview and page metadata to reflect the APIs’ stable status.
File Description
src/​frontend/​src/​content/​docs/​diagnostics/​overview.mdx Updates the diagnostic’s classification and description to note graduation in Aspire 17.0.
src/​frontend/​src/​content/​docs/​diagnostics/​aspireprobes001.mdx Adds the graduation notice, historical context, and upgrade 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