Skip to content

[docs] Document ASPIRE_CLI_START_TIMEOUT environment variable - #1529

Merged
David Pine (IEvangelist) merged 1 commit into
release/13.5from
docs/pr-16686-32142804994-1-249257ab2d9a09f8
Aug 18, 2026
Merged

[docs] Document ASPIRE_CLI_START_TIMEOUT environment variable#1529
David Pine (IEvangelist) merged 1 commit into
release/13.5from
docs/pr-16686-32142804994-1-249257ab2d9a09f8

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#16686

@sebastienros

Targeting release/13.5 — the latest release branch on microsoft/aspire.dev — because release/13.4 (from the source PR milestone 13.4) does not exist there.

Why

microsoft/aspire#16686 adds the ASPIRE_CLI_START_TIMEOUT environment variable so aspire run and aspire 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. Neither aspire-run.mdx nor aspire-start.mdx previously mentioned this env var.

What changed

  • src/frontend/src/content/docs/reference/cli/commands/aspire-run.mdx: added a "Configuring the startup timeout" section describing ASPIRE_CLI_START_TIMEOUT, its default (120s), the invalid-value error behavior, and how it differs from aspire 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 to aspire start as well.
  • src/frontend/src/content/docs/reference/cli/commands/aspire-wait.mdx: added a clarifying sentence distinguishing the resource-level --timeout option from the AppHost-level ASPIRE_CLI_START_TIMEOUT variable, with a cross-reference link.

No new pages were created; all three existing command reference pages were updated in place.

Generated by PR Documentation Check · auto · 71.8 AIC · ⌖ 6.83 AIC · ⊞ 19.6K ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Aug 18, 2026
@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review August 18, 2026 13:45
Copilot AI lite review requested due to automatic review settings August 18, 2026 13:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 run docs describing ASPIRE_CLI_START_TIMEOUT, its default (120s), and invalid-value behavior.
  • Added the same “Configuring the startup timeout” section to aspire start docs.
  • Clarified in aspire wait docs that --timeout is resource-scoped and distinct from ASPIRE_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.

@IEvangelist
David Pine (IEvangelist) marked this pull request as draft August 18, 2026 13:56
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1529. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1529 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review August 18, 2026 14:07
@IEvangelist
David Pine (IEvangelist) merged commit 76e53cf into release/13.5 Aug 18, 2026
11 of 12 checks passed
@IEvangelist
David Pine (IEvangelist) deleted the docs/pr-16686-32142804994-1-249257ab2d9a09f8 branch August 18, 2026 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants