From b2d8e7be7587369fd7f2e2ea008aeb349085aa8b Mon Sep 17 00:00:00 2001 From: "aspire-repo-bot[bot]" <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Date: Wed, 27 May 2026 14:35:47 +0000 Subject: [PATCH 1/2] docs: update aspire do --list-steps to require step argument The aspire do command now requires a step argument when using --list-steps. Running 'aspire do --list-steps' without a step emits a friendly error message pointing at concrete examples like 'aspire do deploy --list-steps'. Documents changes from microsoft/aspire#17535. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../docs/reference/cli/commands/aspire-do.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx index 66acde01d..be47252a2 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx @@ -96,15 +96,15 @@ The following options are available: Before executing a pipeline step, you can discover what steps are available in your application's pipeline and understand their dependencies. Aspire provides two complementary tools for this: -- `aspire do --list-steps` — a quick, compact listing of every pipeline step with its direct dependencies and tags. Available on `aspire deploy`, `aspire publish`, `aspire destroy`, and `aspire do`. Useful for a fast "what would happen?" view before running a command. +- `aspire do --list-steps` — a quick, compact listing of every pipeline step with its direct dependencies and tags. Available on `aspire deploy`, `aspire publish`, `aspire destroy`, and `aspire do`. Useful for a fast "what would happen?" view before running a command. The `step` argument is required when using `--list-steps` with `aspire do`. - `aspire do diagnostics` — a verbose, in-depth report. The `diagnostics` step is itself part of the pipeline, so `aspire do diagnostics` runs it like any other step. ### Quick listing with `--list-steps` -Running `aspire do --list-steps` produces a numbered list of every step in the pipeline, what each one depends on, and any tags it carries: +Running `aspire do --list-steps` produces a numbered list of every step in the pipeline, what each one depends on, and any tags it carries. The step argument is required — `aspire do` is always step-targeted, so `--list-steps` without a step has no meaningful scope. Omitting the step produces a friendly error that suggests concrete examples: ```bash title="Aspire CLI" -aspire do --list-steps +aspire do deploy --list-steps ``` Example output: @@ -162,13 +162,13 @@ Resources in your application can contribute their own custom steps, and you can The following examples demonstrate common pipeline operations: -- Quickly list the steps in your pipeline: +- Quickly list the steps in your pipeline for a specific step: ```bash title="Aspire CLI" - aspire do --list-steps + aspire do deploy --list-steps ``` - This displays a compact view of every step with its dependencies and tags. Use it for a fast "what would happen?" check before running a pipeline command. + This displays a compact view of every step with its dependencies and tags. Use it for a fast "what would happen?" check before running a pipeline command. A step argument is required; `aspire do --list-steps` without a step produces a friendly error. - Run the `diagnostics` step for an in-depth report: From 8a0446db657cfe831d46e05ec69ace5e7ae8169d Mon Sep 17 00:00:00 2001 From: David Pine <7679720+IEvangelist@users.noreply.github.com> Date: Fri, 29 May 2026 15:28:21 -0500 Subject: [PATCH 2/2] Address review feedback (2 threads) - Format the `step` argument as inline code in the quick listing section (PRRT_kwDOQK_VN86FIbZ7) - Format the `step` argument as inline code in the examples section (PRRT_kwDOQK_VN86FIbah) Verified against microsoft/aspire@0cbaf82dab7d2dec5cf2fbda7577e7eaca6e86b1 on branch release/13.4. Edited per the doc-writer skill. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../src/content/docs/reference/cli/commands/aspire-do.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx index be47252a2..aa8669d8b 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx @@ -101,7 +101,7 @@ Before executing a pipeline step, you can discover what steps are available in y ### Quick listing with `--list-steps` -Running `aspire do --list-steps` produces a numbered list of every step in the pipeline, what each one depends on, and any tags it carries. The step argument is required — `aspire do` is always step-targeted, so `--list-steps` without a step has no meaningful scope. Omitting the step produces a friendly error that suggests concrete examples: +Running `aspire do --list-steps` produces a numbered list of every step in the pipeline, what each one depends on, and any tags it carries. The `step` argument is required — `aspire do` is always step-targeted, so `--list-steps` without a step has no meaningful scope. Omitting the step produces a friendly error that suggests concrete examples: ```bash title="Aspire CLI" aspire do deploy --list-steps @@ -168,7 +168,7 @@ The following examples demonstrate common pipeline operations: aspire do deploy --list-steps ``` - This displays a compact view of every step with its dependencies and tags. Use it for a fast "what would happen?" check before running a pipeline command. A step argument is required; `aspire do --list-steps` without a step produces a friendly error. + This displays a compact view of every step with its dependencies and tags. Use it for a fast "what would happen?" check before running a pipeline command. A `step` argument is required; `aspire do --list-steps` without a step produces a friendly error. - Run the `diagnostics` step for an in-depth report: