[docs] Update aspire wait and aspire describe docs for reusable resource observation - #1591
Draft
aspire-repo-bot[bot] wants to merge 1 commit into
Draft
Conversation
Co-authored-by: Copilot <[email protected]>
14 tasks
aspire-repo-bot
Bot
requested a review
from Karol Zadora-Przylecki (karolz-ms)
August 27, 2026 21:12
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
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.
Documents changes from microsoft/aspire#19567
@adamintTargeting
release/13.6based on the source PR milestone13.6.Why
PR #19567 refactors CLI resource observation into a reusable, typed
ResourceWaitServiceand reworksResourceSnapshotWatcherto use a singlecoalesced subscription for both initial state and subsequent updates. Two
user-visible behavior changes result:
aspire wait <resource> --status downnow fails (exit code 18) if theresource enters
FailedToStart, instead of treating that as a successful"down" outcome. The wait service applies one monotonic timeout and always
treats
FailedToStartas terminal failure, "even when waiting for aresource to be down" (PR description).
aspire describe --follownow emits the current state of every resourceimmediately when streaming starts (closing the previous snapshot/watch gap),
even if no later change occurs, in addition to streaming subsequent updates.
Changes
reference/cli/commands/aspire-wait.mdx:FailedToStart, regardless of the target status (previously scoped to"waiting for
uporhealthy").FailedToStartresource always fails the wait, even when the targetstatus is
down.reference/cli/commands/aspire-describe.mdx:--followoption description to state that the current stateof every resource is emitted immediately when streaming starts, even if no
further changes occur.
No new commands, flags, or public docs-relevant types were introduced by this
PR that require new pages — the new
KnownResourceStateswell-known states(
FailedToStart, etc.) were already documented onextensibility/custom-resources.mdxprior to this PR (the type itself justmoved files internally).