Fix CLI/docs consistency: document --shellcheck and --version, normalize update flag help - #50280
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix inconsistencies in CLI help output
Fix CLI/docs consistency: document --shellcheck and --version, normalize update flag help
Aug 4, 2026
pelikhan
marked this pull request as ready for review
August 4, 2026 14:53
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns CLI documentation and update help text with actual command options.
Changes:
- Documents global
--versionand compile--shellcheck. - Clarifies
--forceand normalizes--no-*help wording.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/setup/cli.md |
Documents missing CLI flags. |
pkg/cli/update_command.go |
Revises update flag descriptions. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Balanced
Comment on lines
+171
to
+172
| cmd.Flags().Bool("no-release-bump", false, "Skip automatic major version bumps for non-core actions (only core actions/* are bumped)") | ||
| cmd.Flags().Bool("disable-release-bump", false, "Skip automatic major version bumps for non-core actions (only core actions/* are bumped)") |
6 tasks
Contributor
|
🎉 This pull request is included in a new release. Release: |
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
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.
The CLI consistency audit found
gh aw compile --shellcheckand the global--versionflag missing from the docs, plus inconsistent help wording ongh aw update's negation flags.Docs (
docs/src/content/docs/setup/cli.md)--shellcheckto thecompileOptions summary.--versionrow to the Global Options table (previously only theversionsubcommand was mentioned).gh aw updatehelp text (pkg/cli/update_command.go)--force: now scoped explicitly — "Force update of workflow files even if no changes are detected".--no-merge,--no-redirect,--no-release-bump(and deprecated--disable-release-bump) rewritten to the "Skip X" phrasing used by the rest of the CLI:Notes on findings not applied
--pyflakesis only registered onlint, notcompile, so it was intentionally left out ofcompile's Options list.update --forceto--force-updatewould be a breaking CLI change; the clarified description addresses the ambiguity without breaking existing invocations.