[docs] Add OS information check to aspire doctor docs#1267
[docs] Add OS information check to aspire doctor docs#1267aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Add documentation for the new operating system check introduced in microsoft/aspire#18252. The check appears in the Environment section of `aspire doctor` output and includes structured metadata in JSON format. Changes: - Update Environment checks description to mention OS reporting - Add OS check to sample table output - Add operating-system entry to JSON output example - Document the osType/displayName/version/description metadata fields Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
There was a problem hiding this comment.
Pull request overview
Updates the aspire doctor reference documentation to reflect the new “Operating system” environment check added in microsoft/aspire#18252, including updated table output and JSON schema details for tooling.
Changes:
- Expand “Environment checks” description to include OS reporting details (type/version/distro info).
- Update the sample table output to include the OS check and adjust the summary count accordingly.
- Extend the JSON output example and documentation with the new
operating-systemcheck and its metadata fields.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **SDK checks**: Verifies .NET SDK installation and version requirements | ||
| - **Container checks**: Validates container runtime (Docker and/or Podman) availability, running status, and version. Reports which runtime is active and why (explicit configuration, auto-detected default, or auto-detected only runtime running) | ||
| - **Environment checks**: Validates environment variables and other settings, including the JavaScript toolchain required by TypeScript AppHosts (npm, pnpm, Yarn, or Bun) | ||
| - **Environment checks**: Reports operating system information (type, version, and Linux distro details when available) and validates environment variables and other settings, including the JavaScript toolchain required by TypeScript AppHosts (npm, pnpm, Yarn, or Bun) |
| Environment | ||
| ✅ Operating system: macOS 15.5.0 | ||
| ✅ HTTPS development certificate is trusted | ||
|
|
||
| Summary: 5 passed, 0 warnings, 0 failed | ||
| Summary: 6 passed, 0 warnings, 0 failed |
|
[docs-from-code-ci-note] CI has been retriggered multiple times and is still failing due to the current PR changes (not a transient runner issue). Please update the PR changes to fix the failing checks. |
|
We've retriggered CI multiple times, and the current failures appear tied to changes in this PR rather than a transient pipeline issue. This likely needs a fix in the PR branch before CI will pass. |
|
CI has been retriggered multiple times and is still failing for this PR (latest failures: 'CI' (attempt 8)). This likely needs changes in the PR itself rather than another rerun. |
|
This PR has had CI retriggered multiple times and is still failing on PR-specific checks. It likely needs a change in this PR to pass. |
|
[docs-from-code automation] repeated-rerun-note |
|
We've retriggered CI many times on this PR and it's still failing. At this point, the failure likely comes from changes in this PR rather than transient CI flakiness, so this probably needs a content/code fix in the PR itself. |
|
CI has failed repeatedly on this docs-from-code PR after multiple reruns, and the failures appear to be related to the changes in this PR. Please review and adjust the PR content so the checks can pass. |
|
CI has been retriggered multiple times on this PR and is still failing. The failures appear tied to the current PR changes rather than a transient runner issue, so this likely needs an update in the PR content before CI will pass. |
Documents changes from microsoft/aspire#18252, authored by
@danegsta.Targeting
release/13.5based on the source PR milestone13.5(exact match onmicrosoft/aspire.dev).Why this PR is needed
microsoft/aspire#18252 adds a new Operating system environment check to the
aspire doctorcommand. The check is always present and surfaces OS details in both human-readable table output and JSON output, including a structured metadata payload useful for tooling. The existingaspire-doctor.mdxreference page needed updates to reflect this new check.Triggered signals
cli_resource_strings_changed:src/Aspire.Cli/Resources/DoctorCommandStrings.resxwas modified, adding theOperatingSystemMessageFormatresource string ("Operating system: {0}").pr_body_has_user_facing_section: The PR body contains a### User-facing usageheading with sample table and JSON output.pr_body_has_cli_flag_mention: The PR body references--format jsonin the validation instructions.What changed
src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx/etc/os-release).✅ Operating system: macOS 15.5.0in the Environment section and bumped the summary count from 5 to 6.operating-systemcheck entry to the JSON output example with all four metadata fields (osType,displayName,version,description).Additional update needed
The
aspire-13-5.mdxWhat's New page also needs a bullet in the CLI improvements and diagnostics section. Please add the following before the "Embedded Aspire skills bundle fallback" bullet:Files modified
src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx(updated)