[docs] Update aspire run/stop graceful shutdown documentation#1291
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Open
[docs] Update aspire run/stop graceful shutdown documentation#1291aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
- Expand aspire-run.mdx 'Stopping the AppHost' section with the full three-step shutdown ladder (cooperative cancellation → graceful wait → automatic force-kill) and clarify the second Ctrl+C behavior. - Add a Windows note about isolated console session for tsx/npm AppHosts. - Correct aspire-stop.mdx description: signal targets the AppHost process directly, not an intermediary CLI process. Source: microsoft/aspire#17814 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
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. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Aspire CLI reference docs to reflect the unified graceful shutdown behavior for aspire run and the updated semantics of aspire stop, aligning the documentation with recent CLI behavior changes.
Changes:
- Expanded
aspire run“Stopping the AppHost” section to document the 3-step shutdown sequence and the effect of a second Ctrl+C. - Added a Windows-specific note about isolated console sessions for Node.js-based AppHosts started via
tsx/npm. - Clarified
aspire stopto state it sends a graceful stop signal to the running AppHost process.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/reference/cli/commands/aspire-run.mdx | Documents the updated, unified shutdown ladder and adds a Windows note for TS/JS AppHosts. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-stop.mdx | Updates wording to match the current stop signal behavior (graceful stop to AppHost). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Improves the documentation for
aspire runandaspire stopto accurately reflect the unified graceful shutdown behavior introduced in microsoft/aspire#17814.Changes
reference/cli/commands/aspire-run.mdx— Expanded "Stopping the AppHost" section::::notecallout explaining the Windows isolated console session behavior for TypeScript/JavaScript AppHosts started withtsxornpm— this is a new behavior from the PR that could otherwise confuse users who notice the extra console window.reference/cli/commands/aspire-stop.mdx— One-line fix:aspire stopwith theaspire runshutdown path.Related
Triggered signals
cli_command_file_changed:RunCommand.cs,StopCommand.cs,DashboardRunCommand.cs— shutdown behavior changed in user-visible ways.new_public_type:WindowsProcessInterop.csaddedSTARTUPINFOEXstruct — internal P/Invoke; documented indirectly via the Windows note callout.