[docs] Document --list-steps and --no-build pipeline options#801
Merged
davidfowl merged 1 commit intorelease/13.3from May 5, 2026
Merged
[docs] Document --list-steps and --no-build pipeline options#801davidfowl merged 1 commit intorelease/13.3from
davidfowl merged 1 commit intorelease/13.3from
Conversation
davidfowl
force-pushed
the
docs/list-steps-pipeline-commands
branch
from
4214957 to
1faa3c8
Compare
IEvangelist
approved these changes
May 4, 2026
Add shared option includes for --list-steps and --no-build, and reference them from the aspire deploy, aspire publish, and aspire do command pages. These options are exposed by every pipeline command but were undocumented. Also replace stale 'aspire do diagnostics' references in aspire-do.mdx with 'aspire do --list-steps' (the diagnostics subcommand was removed from the CLI; --list-steps is the replacement). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
davidfowl
force-pushed
the
docs/list-steps-pipeline-commands
branch
from
1faa3c8 to
5186035
Compare
This was referenced May 6, 2026
mitchdenny
added a commit
that referenced
this pull request
May 6, 2026
#847) The reference docs for aspire do and the deployment/pipelines conceptual page already document the --list-steps flag, but neither shows what the output actually looks like. Add a short, canonical numbered-tree sample (matches the formatter in microsoft/aspire#16085 and its snapshot tests) so readers can see at a glance what to expect — including the connectors used for steps with deps only, deps and tags, and steps with no dependencies. Context: #837 (item #2), follow-up polish to #801. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
2 participants
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.
Summary
The pipeline commands (
aspire deploy,aspire publish,aspire do,aspire destroy) all expose two undocumented options:--list-steps— list the pipeline steps that would be executed, without running them.--no-build— don't build/restore the AppHost project before running.This PR adds shared option includes for both flags and references them from the deploy, publish, and do command reference pages.
Stale-content fix
The
aspire-do.mdxpage still talks aboutaspire do diagnostics, a subcommand that was removed from the CLI in favor of--list-steps. This PR replaces those references withaspire do --list-steps.Notes
aspire-destroy.mdxdoesn't exist onrelease/13.3yet, so it's not touched here. It will get the same options when its reference page lands ([docs] Add aspire destroy command documentation #769).Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com