Skip to content

[release/9.2] Adding descriptions to all args/options in CLI. (#8544) - #8552

Merged
Dan Moseley (danmoseley) merged 2 commits into
release/9.2from
mitchdenny/cherry-pick-8544-to-release-9.2
Apr 4, 2025
Merged

[release/9.2] Adding descriptions to all args/options in CLI. (#8544)#8552
Dan Moseley (danmoseley) merged 2 commits into
release/9.2from
mitchdenny/cherry-pick-8544-to-release-9.2

Conversation

@mitchdenny

Copy link
Copy Markdown
Member

Backport of #8544 to release/9.2

/cc Mitch Denny (@mitchdenny)

Customer Impact / Notes

This PR adds improved help text to the CLI. Note that this PR also reverts one aspect of a change in pending backport #8543. That one should be merged first, then this one. A merge conflict could occur. If I am not around to resolve it myself and someone else wants to have a go - the conflict will be around the --project option on the run command being an option or an argument in S.CL.

... we want it to be an option after some further discussion.

Testing

Manually tested.

Risk

Low.

Regression?

No.

* Adding descriptions to all args/options in CLI.
* Revert project arg to option.
* PR feedback.
* Rename resource to integration.
* Update src/Aspire.Cli/Commands/RunCommand.cs
Co-authored-by: David Fowler <davidfowl@gmail.com>
---------
Co-authored-by: David Fowler <davidfowl@gmail.com>
CopilotAI review requested due to automatic review settings April 4, 2025 09:36
@github-actionsgithub-actionsBot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Apr 4, 2025

CopilotAI 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.

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

src/Aspire.Cli/Commands/RootCommand.cs:18

  • [nitpick] The updated constructor for RootCommand now passes a lengthy help string to the base constructor instead of a short command identifier. Confirm that this change is intentional to ensure consistency with similar commands.
: base("The Aspire CLI can be used to create, run, and publish Aspire-based applications.")

@danmoseleyDan Moseley (danmoseley) added Servicing-approved Approved for servicing release and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Apr 4, 2025
@eerhardt

Copy link
Copy Markdown
Member

I'm fixing the merge conflict

@danmoseley

Copy link
Copy Markdown
Contributor

I was fixing it too, then github got really confused :)

@danmoseley
Dan Moseley (danmoseley) enabled auto-merge (squash) April 4, 2025 15:34
@danmoseley
Dan Moseley (danmoseley) merged commit ed06d7a into release/9.2Apr 4, 2025
@danmoseley
Dan Moseley (danmoseley) deleted the mitchdenny/cherry-pick-8544-to-release-9.2 branch April 4, 2025 15:45
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 5, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-cliServicing-approvedApproved for servicing release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@mitchdenny@eerhardt@danmoseley@davidfowl@adamint