Skip to content

Friendly error for 'aspire do --list-steps' without a step#17535

Merged
mitchdenny merged 4 commits into
mainfrom
mitchdenny/issue-17526-aspire-do-list-steps-fails-with-sequence-401909
May 27, 2026
Merged

Friendly error for 'aspire do --list-steps' without a step#17535
mitchdenny merged 4 commits into
mainfrom
mitchdenny/issue-17526-aspire-do-list-steps-fails-with-sequence-401909

Conversation

@mitchdenny
Copy link
Copy Markdown
Member

Description

aspire do is always step-targeted, so --list-steps with no step has no meaningful scope. The validator previously allowed aspire do --list-steps to run, which launched the AppHost and raced ahead executing the full pipeline before the CLI could fetch steps and stop it. That race surfaced as InvalidOperationException: Sequence contains more than one matching element from AzurePublishingContext (#17526).

This change tightens the DoCommand validator to always require the step argument (outside the extension host, which prompts interactively). When the user specifies --list-steps without a step, the CLI now emits a friendly, localized error pointing at concrete examples drawn from the well-known step names:

The 'step' argument is required when using --list-steps. Specify the step you want to inspect, for example: 'aspire do deploy --list-steps' or 'aspire do publish --list-steps'.

aspire publish --list-steps and aspire deploy --list-steps are unchanged - they already pass a fixed --step and continue to work.

Scope was kept intentionally narrow: no changes to PipelineOptions / PipelineExecutor / AppHost. The underlying "more than one matching element" condition in ResourceExtensions.GetDeploymentTargetAnnotation is a separate latent bug that only surfaced because the pipeline ran when it shouldn't have.

Files of note

  • src/Aspire.Cli/Commands/DoCommand.cs - tightened validator with branch-specific friendly message.
  • src/Aspire.Cli/Resources/DoCommandStrings.resx + Designer.cs - new StepArgumentRequired and ListStepsRequiresStep entries (and the previously inlined English error promoted to a resource).
  • src/Aspire.Cli/Resources/xlf/DoCommandStrings.*.xlf - refreshed via dotnet build /t:UpdateXlf (translation pipeline owns the actual translations).
  • tests/Aspire.Cli.Tests/Commands/DoCommandTests.cs - new DoCommandWithListStepsAndNoStepArgumentShowsFriendlyError regression test; three existing list-steps tests updated to pass a step.
  • tests/Aspire.Cli.EndToEnd.Tests/ListStepsTests.cs - single Docker-backed E2E now exercises aspire do --list-steps (asserts the friendly error and explicitly fails if the Sequence contains more than one matching element crash returns), plus aspire do deploy --list-steps, aspire publish --list-steps, and aspire deploy --list-steps against a freshly created starter app.

Fixes: #17526

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No

'aspire do' is always step-targeted, so '--list-steps' with no step has no
meaningful scope. The validator previously allowed it, which caused the CLI
to launch the AppHost and race ahead executing the full pipeline before
the CLI could fetch steps and stop. That race surfaced as
'InvalidOperationException: Sequence contains more than one matching
element' from AzurePublishingContext (#17526).

Tighten the DoCommand validator to always require the step argument
(outside the extension host, which prompts interactively). When the user
specifies '--list-steps' without a step, emit a friendly, localized error
pointing at concrete examples: 'aspire do deploy --list-steps' or
'aspire do publish --list-steps'.

Adds StepArgumentRequired and ListStepsRequiresStep entries to
DoCommandStrings.resx + Designer.cs and refreshes all xlf translations
via UpdateXlf.

Tests:
 - DoCommandTests: new DoCommandWithListStepsAndNoStepArgumentShowsFriendlyError
   regression case; existing list-steps tests updated to pass a step.
 - ListStepsTests (E2E): single Docker-backed test now exercises
   'aspire do --list-steps' (asserts friendly error and the absence of
   the 'Sequence contains more than one matching element' crash) plus
   'aspire do deploy --list-steps', 'aspire publish --list-steps' and
   'aspire deploy --list-steps' against a freshly created starter app.

Fixes: #17526

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17535

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17535"

mitchdenny and others added 2 commits May 27, 2026 18:01
Expand the 'aspire do --list-steps' validation error to enumerate every
well-known pipeline step instead of just naming 'deploy' and 'publish'.
The step names are hand-maintained in DoCommand alongside a comment
pointing at src/Aspire.Hosting/Pipelines/WellKnownPipelineSteps.cs (the
CLI does not reference Aspire.Hosting). Updated unit and E2E assertions
to match the new message shape.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replace the long enumeration of well-known step names with a short,
opinionated suggestion (build, publish, deploy) and a link to the
official 'aspire do' reference page on aspire.dev for the full list.
This removes the hand-maintained mirror of WellKnownPipelineSteps in
DoCommand and simplifies localization since the message no longer takes
a format parameter.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@mitchdenny
Copy link
Copy Markdown
Member Author

PR Testing Report

PR Information

CLI Version Verification

  • Expected Commit: 93d47a9d
  • Installed Version: 13.5.0-pr.17535.g93d47a9d
  • Status: ✅ Verified

Changes Analyzed

Files Changed

  • src/Aspire.Cli/Commands/DoCommand.cs — Validator always requires a step argument (outside extension host)
  • src/Aspire.Cli/Resources/DoCommandStrings.resx + Designer.cs + 13 xlf files — Added StepArgumentRequired and ListStepsRequiresStep localized strings
  • tests/Aspire.Cli.Tests/Commands/DoCommandTests.cs — Regression test + updated 3 existing tests
  • tests/Aspire.Cli.EndToEnd.Tests/ListStepsTests.cs — New consolidated E2E test

Change Categories

  • CLI changes
  • Hosting integration changes
  • Dashboard changes
  • Template changes
  • Client/Component changes
  • Test changes

Test Scenarios Executed

Scenario 1: aspire do --list-steps (no step argument)

Objective: Reproduce issue #17526 and verify the fix surfaces a friendly error instead of Sequence contains more than one matching element.
Coverage Type: Unhappy path (the fix)
Status: ✅ Passed

Output:

The 'step' argument is required when using --list-steps.
Example: 'aspire do deploy --list-steps'.
Common starting steps are 'build', 'publish' and 'deploy'.
See https://aspire.dev/reference/cli/commands/aspire-do/ for the full list of pipeline steps.

Exit code: 1. No Sequence contains more than one matching element text appeared.


Scenario 2: aspire do (no arguments)

Objective: Validator rejects missing step argument with a clear message.
Coverage Type: Unhappy path / boundary
Status: ✅ Passed

Output: The 'step' argument is required. Exit code: 1.


Scenario 3: aspire do deploy --list-steps (happy path against aspire-empty AppHost)

Objective: Existing happy path still works after tightening the validator.
Status: ✅ Passed

Output:

🛠️ Listing pipeline steps
1. deploy
   └─ No dependencies

Exit code: 0.


Scenario 4: aspire publish --list-steps

Objective: Sibling command unaffected by changes.
Status: ✅ Passed (exit 0, lists the publish step).


Scenario 5: aspire deploy --list-steps

Objective: Sibling command unaffected by changes.
Status: ✅ Passed (exit 0, lists the deploy step).

Summary

Scenario Status
1. aspire do --list-steps → friendly error ✅ Passed
2. aspire do → step required ✅ Passed
3. aspire do deploy --list-steps → list ✅ Passed
4. aspire publish --list-steps → list ✅ Passed
5. aspire deploy --list-steps → list ✅ Passed

Overall Result

✅ PR VERIFIED

Issue #17526 is fixed: aspire do --list-steps without a step now exits with a friendly localized error that points users at build/publish/deploy and the aspire.dev pipeline-steps docs, instead of crashing with Sequence contains more than one matching element. The --list-steps happy paths for do <step>, publish, and deploy are unaffected.

@mitchdenny mitchdenny marked this pull request as ready for review May 27, 2026 08:42
Copilot AI review requested due to automatic review settings May 27, 2026 08:42
Copy link
Copy Markdown
Member Author

@mitchdenny mitchdenny left a comment

Choose a reason for hiding this comment

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

Code review (2 findings) — both moderate, see inline comments.

Comment thread src/Aspire.Cli/Commands/DoCommand.cs Outdated
Comment thread tests/Aspire.Cli.EndToEnd.Tests/ListStepsTests.cs
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Tightens aspire do validation so --list-steps requires a positional step argument, preventing the AppHost from launching and crashing with "Sequence contains more than one matching element" (#17526). When the step is missing, the CLI now emits a friendly localized error referencing common steps and the docs URL.

Changes:

  • DoCommand validator always requires a step argument outside the extension host, with a list-steps-specific friendly error.
  • New localized resources StepArgumentRequired and ListStepsRequiresStep (resx, Designer, and xlf for all locales).
  • Unit test for the new parse-error path; existing do --list-steps tests updated to pass a step; E2E test expanded to cover the friendly error and publish/deploy --list-steps.
Show a summary per file
File Description
src/Aspire.Cli/Commands/DoCommand.cs Validator now errors on missing step (branching message for --list-steps).
src/Aspire.Cli/Resources/DoCommandStrings.resx Adds StepArgumentRequired and ListStepsRequiresStep.
src/Aspire.Cli/Resources/DoCommandStrings.Designer.cs Generated accessors for the new strings.
src/Aspire.Cli/Resources/xlf/DoCommandStrings.*.xlf (13 locales) New trans-units added via UpdateXlf.
tests/Aspire.Cli.Tests/Commands/DoCommandTests.cs New parse-error test; existing --list-steps tests pass deploy.
tests/Aspire.Cli.EndToEnd.Tests/ListStepsTests.cs Renamed/expanded E2E to cover friendly error plus do/publish/deploy --list-steps.

Copilot's findings

Files not reviewed (1)
  • src/Aspire.Cli/Resources/DoCommandStrings.Designer.cs: Language not supported
  • Files reviewed: 17/18 changed files
  • Comments generated: 0

- DoCommand validator: fire the ListStepsRequiresStep friendly error
  for `aspire do --list-steps` even when running in the extension host,
  because --list-steps does not flow through GetRunArgumentsAsync's
  interactive step prompt and would otherwise still hit the original
  pipeline crash from #17526.
- ListStepsTests (E2E): replace long, wrap-sensitive substrings with
  short fragments ("required when using --list-steps", "aspire.dev/")
  so the assertion does not fail when the friendly error wraps in a
  narrow Docker terminal.
- DoCommandTests: add DoCommandWithListStepsAndNoStepArgumentInExtensionHostShowsFriendlyError
  to regression-test the extension-host path.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@mitchdenny
Copy link
Copy Markdown
Member Author

PR Testing Report (re-test after review fixes)

PR Information

CLI Version Verification

  • Expected Commit: 562e7fa6
  • Installed Version: 13.5.0-pr.17535.g562e7fa6
  • Status: ✅ Verified

CI Status (run 26502110363)

  • 305 pass / 1 skip
  • 1 pending (Hosting-1 / windows-latest — still running, unrelated to CLI change)
  • 1 fail (RabbitMQ.Client.v6 / windows-latest — known-flaky integration test, "Check for hang dump files" step, unrelated to CLI change)
  • Cli.EndToEnd-ListStepsTests / ubuntu-latest passed in 4m0s with the new wrap-resistant assertions
  • Cli / Cli (ubuntu-latest|macos-latest|windows-latest) all passed (includes the new DoCommandWithListStepsAndNoStepArgumentInExtensionHostShowsFriendlyError regression test)

Test Scenarios Re-Executed

# Scenario Result
1 aspire do --list-steps (no step) ✅ Friendly error with build/publish/deploy + docs URL, exit 1
2 aspire do (no args) ✅ "step required" error, exit 1
3 aspire do deploy --list-steps ✅ Lists deploy step, exit 0
4 aspire publish --list-steps ✅ Lists publish step, exit 0
5 aspire deploy --list-steps ✅ Lists deploy step, exit 0

No Sequence contains more than one matching element text in any scenario.

Review Fixes Verified

  • Extension-host bypass (DoCommand.cs) — now triggers the friendly ListStepsRequiresStep error in extension host too, instead of falling through to the original crash path. New unit test DoCommandWithListStepsAndNoStepArgumentInExtensionHostShowsFriendlyError passes in CI.
  • Wrap-sensitive E2E assertions (ListStepsTests.cs) — replaced 30/43-char substrings with "required when using --list-steps" and "aspire.dev/". The Cli.EndToEnd-ListStepsTests job passed in CI.

Overall Result

✅ PR VERIFIED

The two review findings are addressed, the regression unit test and the E2E test both pass in CI, and the original #17526 crash is gone in all five local scenarios.

@github-actions
Copy link
Copy Markdown
Contributor

Re-running the failed jobs in the CI workflow for this pull request because 1 job was identified as retry-safe transient failures in the CI run attempt.
GitHub was asked to rerun all failed jobs for that attempt, and the rerun is being tracked in the rerun attempt.
The job links below point to the failed attempt jobs that matched the retry-safe transient failure rules.

@github-actions
Copy link
Copy Markdown
Contributor

CLI E2E Tests unknown — 107 passed, 0 failed, 2 unknown (commit 562e7fa)

View all recordings
Status Test Recording
AddPackageInteractiveWhileAppHostRunningDetached ▶️ View recording
AddPackageWhileAppHostRunningDetached ▶️ View recording
AgentCommands_AllHelpOutputs_AreCorrect ▶️ View recording
AgentInitCommand_DefaultSelection_InstallsDefaultSkills ▶️ View recording
AgentInitCommand_MigratesDeprecatedConfig ▶️ View recording
AgentMcpListStructuredLogsReturnsLogsFromStarterApp ▶️ View recording
AgentMcpListStructuredLogsReturnsLogsFromStarterApp_DevLocalhost ▶️ View recording
AgentMcpListStructuredLogsReturnsLogsFromStarterApp_Isolated ▶️ View recording
AllPublishMethodsBuildDockerImages ▶️ View recording
AspireAddAndStartWorkAgainstLegacyAppHostTs ▶️ View recording
AspireAddPackageVersionToDirectoryPackagesProps ▶️ View recording
AspireInitSingleFileAppHostRunsViaDotnetRunAppHost ▶️ View recording
AspireInitWithExistingAppHostDirRecreatesMissingNuGetConfigAndPreservesFiles ▶️ View recording
AspireInitWithSolutionFileGeneratesAppHostThatBuildsAgainstChannelHive ▶️ View recording
AspireStartUpdatesStaleTypeScriptAppHostPath ▶️ View recording
AspireUpdateRemovesAppHostPackageVersionFromDirectoryPackagesProps ▶️ View recording
AspireUpdateRemovesOrphanAppHostPackageVersionWhenSdkAlreadyCurrent ▶️ View recording
Banner_DisplayedOnFirstRun ▶️ View recording
Banner_DisplayedWithExplicitFlag ▶️ View recording
Banner_NotDisplayedWithNoLogoFlag ▶️ View recording
CertificatesClean_RemovesCertificates ▶️ View recording
CertificatesTrust_WithNoCert_CreatesAndTrustsCertificate ▶️ View recording
CertificatesTrust_WithUntrustedCert_TrustsCertificate ▶️ View recording
ConfigSetGet_CreatesNestedJsonFormat ▶️ View recording
CreateAndRunAspireStarterProject ▶️ View recording
CreateAndRunAspireStarterProjectWithBundle ▶️ View recording
CreateAndRunEmptyAppHostProject ▶️ View recording
CreateAndRunJavaEmptyAppHostProject ▶️ View recording
CreateAndRunJsReactProject ▶️ View recording
CreateAndRunPythonReactProject ▶️ View recording
CreateAndRunTypeScriptEmptyAppHostProject ▶️ View recording
CreateAndRunTypeScriptStarterProject ▶️ View recording
CreateJavaAppHostWithViteApp ▶️ View recording
CreateTypeScriptAppHostWithViteApp_AllowsGuestAppPackageManagerToDiffer ▶️ View recording
CreateTypeScriptAppHostWithViteApp_UsesConfiguredToolchain ▶️ View recording
DashboardRunWithAgentMcpListTracesReturnsNoTraces ▶️ View recording
DashboardRunWithAgentMcpListTracesReturnsNoTraces_DevLocalhost ▶️ View recording
DashboardRunWithOtelTracesReturnsNoTraces ▶️ View recording
DashboardRunWithOtelTracesReturnsNoTraces_DevLocalhost ▶️ View recording
DeployK8sBasicApiService ▶️ View recording
DeployK8sWithExternalHelmChart ▶️ View recording
DeployK8sWithGarnet ▶️ View recording
DeployK8sWithMongoDB ▶️ View recording
DeployK8sWithMySql ▶️ View recording
DeployK8sWithPostgres ▶️ View recording
DeployK8sWithRabbitMQ ▶️ View recording
DeployK8sWithRedis ▶️ View recording
DeployK8sWithSqlServer ▶️ View recording
DeployK8sWithValkey ▶️ View recording
DeployTypeScriptAppToKubernetes ▶️ View recording
DescribeCommandResolvesReplicaNames ▶️ View recording
DescribeCommandShowsRunningResources ▶️ View recording
DetachFormatJsonProducesValidJson ▶️ View recording
DetachFormatJsonProducesValidJsonWhenRestartingExistingInstance ▶️ View recording
DoPublishAndDeployListStepsWork ▶️ View recording
DocsCommand_RendersInteractiveMarkdownFromLocalSource ▶️ View recording
DoctorCommand_DetectsDeprecatedAgentConfig ▶️ View recording
DoctorCommand_TypeScriptAppHostReportsMissingConfiguredToolchain ▶️ View recording
DoctorCommand_WithSslCertDir_ShowsTrusted ▶️ View recording
DoctorCommand_WithoutSslCertDir_ShowsPartiallyTrusted ▶️ View recording
GatewayWithoutExternalEndpoint_FailsPublishWithGuidance ▶️ View recording
GeneratedAspireDevScript_StartsWatchMode_WithConfiguredToolchain ▶️ View recording
GlobalMigration_HandlesCommentsAndTrailingCommas ▶️ View recording
GlobalMigration_HandlesMalformedLegacyJson ▶️ View recording
GlobalMigration_PreservesAllValueTypes ▶️ View recording
GlobalMigration_SkipsWhenNewConfigExists ▶️ View recording
GlobalSettings_MigratedFromLegacyFormat ▶️ View recording
IngressWithoutExternalEndpoint_FailsPublishWithGuidance ▶️ View recording
InitTypeScriptAppHost_AugmentsExistingViteRepoInWorkspaceSubdirectory ▶️ View recording
InteractiveCSharpInitCreatesExpectedFiles ▶️ View recording
InvalidAppHostPathWithComments_IsHealedOnRun ▶️ View recording
JavaScriptHostingApisRunFromTypeScriptAppHost ▶️ View recording
LatestCliCanStartStableChannelAppHost ▶️ View recording
LatestCliCanStartStableChannelTypeScriptAppHost ▶️ View recording
LegacySettingsMigration_AdjustsRelativeAppHostPath ▶️ View recording
LogsCommandShowsResourceLogs ▶️ View recording
OtelLogsReturnsStructuredLogsFromStarterApp ▶️ View recording
OtelLogsReturnsStructuredLogsFromStarterAppIsolated ▶️ View recording
PsCommandListsRunningAppHost ▶️ View recording
PsFormatJsonOutputsOnlyJsonToStdout ▶️ View recording
PublishJavaScriptPatternsGeneratesExpectedDockerComposeArtifacts ▶️ View recording
PublishWithConfigureEnvFileUpdatesEnvOutput ▶️ View recording
PublishWithDockerComposeServiceCallbackSucceeds ▶️ View recording
PublishWithoutOutputPathUsesAppHostDirectoryDefault ▶️ View recording
ResourceCommand_FailedExecution_DisplaysAppHostLogPathAndLogContainsEntries ▶️ View recording
ResourceCommand_SetAndDeleteParameterUpdatesDescribeOutput ▶️ View recording
RestoreGeneratesSdkFiles ▶️ View recording
RestoreGeneratesSdkFiles_WithConfiguredToolchain ▶️ View recording
RestoreRefreshesGeneratedSdkAfterAddingIntegration ▶️ View recording
RestoreSupportsConfigOnlyHelperPackageAndCrossPackageTypes ▶️ View recording
RunFromParentDirectory_UsesExistingConfigNearAppHost ▶️ View recording
RunReportsSyntaxErrorsForDotNetAppHost ▶️ View recording
RunReportsSyntaxErrorsForTypeScriptAppHost ▶️ View recording
SecretCrudOnDotNetAppHost ▶️ View recording
SecretCrudOnTypeScriptAppHost ▶️ View recording
StagingChannel_ConfigureAndVerifySettings_ThenSwitchChannels ▶️ View recording
StartAndWaitForTypeScriptSqlServerAppHostWithNativeAssets ▶️ View recording
StartReportsSyntaxErrorsForDotNetAppHost ▶️ View recording
StartReportsSyntaxErrorsForTypeScriptAppHost ▶️ View recording
StopAllAppHostsFromAppHostDirectory ▶️ View recording
StopJavaPolyglotAppHostUsingApphostDirectory ▶️ View recording
StopNonInteractiveSingleAppHost ▶️ View recording
StopTypeScriptPolyglotAppHostUsingApphostDirectory ▶️ View recording
StopWithNoRunningAppHostExitsSuccessfully ▶️ View recording
UnAwaitedChainsCompileWithAutoResolvePromises ▶️ View recording
UpdateProjectChannelToStable_CSharpEmptyAppHost_PreservesAspireConfigChannel ▶️ View recording
UpdateProjectChannelToStable_CSharpSingleFileInit_PreservesAspireConfigChannel ▶️ View recording
UpdateProjectChannelToStable_TypeScriptSingleFileInit_PreservesAspireConfigChannel ▶️ View recording
UpdateProjectChannelToStable_TypeScript_PreviewsStablePackagesAndPreservesChannel ▶️ View recording

📹 Recordings uploaded automatically from CI run #26502110363

@mitchdenny mitchdenny merged commit d508dec into main May 27, 2026
615 of 619 checks passed
@mitchdenny mitchdenny deleted the mitchdenny/issue-17526-aspire-do-list-steps-fails-with-sequence-401909 branch May 27, 2026 14:24
@microsoft-github-policy-service microsoft-github-policy-service Bot added this to the 13.5 milestone May 27, 2026
@mitchdenny
Copy link
Copy Markdown
Member Author

/backport to release/13.4

@github-actions
Copy link
Copy Markdown
Contributor

Started backporting to release/13.4 (link to workflow run)

aspire-repo-bot Bot added a commit to microsoft/aspire.dev that referenced this pull request May 27, 2026
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>
@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Pull request created: #1091

Generated by PR Documentation Check

@aspire-repo-bot
Copy link
Copy Markdown
Contributor

📝 Documentation has been drafted in microsoft/aspire.dev#1091 targeting release/13.4.

Updated src/frontend/src/content/docs/reference/cli/commands/aspire-do.mdx to reflect that aspire do --list-steps now requires a step argument (e.g., aspire do deploy --list-steps). The previous docs showed bare aspire do --list-steps as a valid example in two places; both are corrected with a note that omitting the step produces a friendly error. Evidence: cli_command_file_changed (DoCommand.cs tightened validator), cli_resource_strings_changed (DoCommandStrings.resx adds ListStepsRequiresStep), pr_body_has_cli_flag_mention (--list-steps usage described in PR body).

Note

This draft PR needs human review before merging.

IEvangelist added a commit to microsoft/aspire.dev that referenced this pull request Jun 1, 2026
…1091)

* 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>

* 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@0cbaf82 on branch release/13.4.
Edited per the doc-writer skill.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

aspire do --list-steps fails with 'Sequence contains more than one matching element' while deploy --list-steps succeeds

3 participants