[docs] Document ASPIRE_CLI_START_TIMEOUT environment variable - #1529
Merged
David Pine (IEvangelist) merged 1 commit intoAug 18, 2026
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
David Pine (IEvangelist)
marked this pull request as ready for review
August 18, 2026 13:45
David Pine (IEvangelist)
requested review from
David Pine (IEvangelist) and
Mitch Denny (mitchdenny)
as code owners
August 18, 2026 13:45
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the newly introduced ASPIRE_CLI_START_TIMEOUT environment variable across Aspire CLI command reference pages, clarifying how it affects AppHost startup readiness vs. resource-level waiting in aspire wait.
Changes:
- Added a “Configuring the startup timeout” section to
aspire rundocs describingASPIRE_CLI_START_TIMEOUT, its default (120s), and invalid-value behavior. - Added the same “Configuring the startup timeout” section to
aspire startdocs. - Clarified in
aspire waitdocs that--timeoutis resource-scoped and distinct fromASPIRE_CLI_START_TIMEOUT, with a cross-reference link.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/reference/cli/commands/aspire-run.mdx | Documents ASPIRE_CLI_START_TIMEOUT behavior for aspire run, including detached startup and distinction from aspire wait --timeout. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-start.mdx | Documents ASPIRE_CLI_START_TIMEOUT behavior for aspire start within the command description section. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-wait.mdx | Adds clarification that --timeout is resource-level and links to the AppHost startup timeout documentation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
David Pine (IEvangelist)
marked this pull request as draft
August 18, 2026 13:56
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
David Pine (IEvangelist)
marked this pull request as ready for review
August 18, 2026 14:07
David Pine (IEvangelist)
requested a review
from Karol Zadora-Przylecki (karolz-ms)
August 18, 2026 14:07
David Pine (IEvangelist)
merged commit Aug 18, 2026
76e53cf
into
release/13.5
11 of 12 checks passed
David Pine (IEvangelist)
deleted the
docs/pr-16686-32142804994-1-249257ab2d9a09f8
branch
August 18, 2026 14:08
50 tasks
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#16686
@sebastienrosTargeting
release/13.5— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.4(from the source PR milestone13.4) does not exist there.Why
microsoft/aspire#16686 adds the
ASPIRE_CLI_START_TIMEOUTenvironment variable soaspire runandaspire start(including detached launches) can wait longer than the default 120-second window for the AppHost to reach a stable running state, with a clear error when the value isn't a valid positive integer. Neitheraspire-run.mdxnoraspire-start.mdxpreviously mentioned this env var.What changed
src/frontend/src/content/docs/reference/cli/commands/aspire-run.mdx: added a "Configuring the startup timeout" section describingASPIRE_CLI_START_TIMEOUT, its default (120s), the invalid-value error behavior, and how it differs fromaspire wait --timeout.src/frontend/src/content/docs/reference/cli/commands/aspire-start.mdx: added the same "Configuring the startup timeout" section, since the timeout applies toaspire startas well.src/frontend/src/content/docs/reference/cli/commands/aspire-wait.mdx: added a clarifying sentence distinguishing the resource-level--timeoutoption from the AppHost-levelASPIRE_CLI_START_TIMEOUTvariable, with a cross-reference link.No new pages were created; all three existing command reference pages were updated in place.