[docs] Update aspire run/stop graceful shutdown documentation#1291
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>
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 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.
|
@copilot resource shutdown runs in the background independent of the graceful AppHost shutdown with their own graceful shutdown budgets and the AppHost doesn't wait for resources to exit before exiting itself. So resources are able to complete their own graceful shutdowns even if the AppHost exits quickly OR is killed after the graceful shutdown budget is exceeded. We should avoid conflating AppHost and resource shutdown in these docs. |
… stop docs Co-authored-by: danegsta <50252651+danegsta@users.noreply.github.com>
Fixed in 2 places:
|
c149075 to
f861bc1
Compare
CI Status NoteThe CI workflow hasn't been triggered for the latest commit pushed by the Copilot cloud agent on July 22, 2026 ( Action needed: A maintainer should push an empty or trivial commit to this branch via the standard git protocol (e.g., Alternatively, squashing/rebasing the PR branch would also work. |
|
@copilot resolve the merge conflicts in this pull request. |
…814-v2-f679de180a79c6e2 Co-authored-by: danegsta <50252651+danegsta@users.noreply.github.com>
Merge conflicts resolved. |
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.