Skip to content

[docs] Note ASPIREFILESYSTEM001 graduation to stable in Aspire 17.0 - #1846

Closed
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20808-37782475885-1-d424207d8403ac70
Closed

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20808-37782475885-1-d424207d8403ac70

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#20808

@mitchdenny

Target branch

Targeting release/17.0 based on the source PR milestone 17.0.

Why this PR is needed

microsoft/aspire#20808 removes the experimental status from the filesystem service APIs — IFileSystemService, ITempFileSystemService, TempDirectory, TempFile, and IDistributedApplicationBuilder.FileSystemService — which previously required suppressing ASPIREFILESYSTEM001. The PR body explicitly states:

Consumers can use Aspire's filesystem services and temporary-file abstractions without suppressing ASPIREFILESYSTEM001.

and

Existing usage no longer needs an experimental-warning suppression:

var builder = DistributedApplication.CreateBuilder(args);
using var temporaryDirectory = builder.FileSystemService.TempDirectory.CreateTempSubdirectory();
using var temporaryFile = builder.FileSystemService.TempDirectory.CreateTempFile("config.json");

The src/frontend/src/content/docs/diagnostics/aspirefilesystem001.mdx page previously had no indication that these APIs had graduated, so a reader hitting old references or search results would believe suppression is still required.

Summary of documentation changes

  • Added an <Aside type="note"> callout to diagnostics/aspirefilesystem001.mdx, following the existing graduation pattern used by aspireazure002.mdx and aspirecosmosdb001.mdx, stating that as of Aspire 17.0 the listed APIs are no longer experimental and no longer trigger ASPIREFILESYSTEM001, and that the diagnostic only applies to earlier Aspire versions.
  • Imported the Aside Starlight component alongside the existing Badge import.

Files modified

  • src/frontend/src/content/docs/diagnostics/aspirefilesystem001.mdx (updated)

No new pages were created; this is a targeted update to the existing diagnostic reference page. The diagnostics/overview.mdx summary table row was intentionally left unchanged, consistent with how prior graduated diagnostics (e.g., ASPIREAZURE002, ASPIRECOSMOSDB001) are represented there — the graduation detail lives on the individual diagnostic page.

Generated by PR Documentation Check for #20808 · copilot · auto · 53.7 AIC · ⌖ 13.2 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 #1846. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1846 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: 2 of 2 claims evaluated; phase B: not run (docs site was not served in this automated run)]

Recommendation: approve (human sign-off on rendering advised)

Source used: microsoft/aspire @ main (507a286); source PR microsoft/aspire#20808 (merged to main, milestone 17.0). The docs PR targets release/17.0; no matching branch was checked.
PR status: draft, mergeable (no conflicts), opened 2026-10-08 (~26 days, not yet stale at 30 days). Head aad446c.

Phase A — claims

# Claim Verdict Evidence
1 IFileSystemService, ITempFileSystemService, TempDirectory, TempFile and IDistributedApplicationBuilder.FileSystemService are no longer experimental as of 17.0 ✅ verified #20808 removes [Experimental("ASPIREFILESYSTEM001")] from these types in IFileSystemService.cs/FileSystemService.cs and adds tests asserting no ExperimentalAttribute. The property is still in IDistributedApplicationBuilder.cs on main.
2 ASPIREFILESYSTEM001 only applies to earlier versions ✅ verified No remaining Experimental("ASPIREFILESYSTEM001") usages in the diff.

Phase B — doc-tester

Not run. The Aside import and render on diagnostics/aspirefilesystem001 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.

🟢 Approval recommended

No active review issues remain for the documentation update clarifying filesystem API stability in Aspire 17.0.

No open issues 🎉

What changed in this PR

Updates the filesystem diagnostic reference to explain that Aspire 17.0 graduates the filesystem service APIs to stable, so readers no longer need to suppress ASPIREFILESYSTEM001.

Changes:

  • Adds a note identifying the stabilized APIs and clarifying that the diagnostic applies only to earlier Aspire versions.
  • Imports Starlight’s Aside component to display the note.
File Description
src/​frontend/​src/​content/​docs/​diagnostics/​aspirefilesystem001.mdx Adds the Aspire 17.0 graduation note while preserving guidance for earlier versions.

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