fix: correct --yes verb, --dir env hint, and add-wizard docs across 9 commands#44050
Conversation
…add-wizard docs - Fix --yes flag: update_command uses 'update', upgrade_command uses 'upgrade' - Fix --dir flag: add $GH_AW_WORKFLOWS_DIR to descriptions in compile, remove (main.go), validate, fix, add, add-wizard, deploy, update, upgrade commands - Update add-wizard docs to include --append and --no-security-scanner options" Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR improves gh aw CLI consistency by aligning help text and docs with existing behavior, especially around workflow directory overrides and org-mode confirmation flags.
Changes:
- Fixed
--yes/-yhelp text verbs forupdateandupgradeto match what the commands actually do. - Updated
--dir/-dhelp text across commands to include the$GH_AW_WORKFLOWS_DIRenvironment variable hint. - Updated
add-wizarddocs to include--appendand--no-security-scannerin the documented options list.
Show a summary per file
| File | Description |
|---|---|
| pkg/cli/validate_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| pkg/cli/upgrade_command.go | Updates --dir help text and fixes --yes help verb to “upgrade confirmations”. |
| pkg/cli/update_command.go | Updates --dir help text and fixes --yes help verb to “update confirmations”. |
| pkg/cli/fix_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| pkg/cli/deploy_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| pkg/cli/add_wizard_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| pkg/cli/add_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| cmd/gh-aw/main.go | Updates compile/remove --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| docs/src/content/docs/setup/cli.md | Adds --append and --no-security-scanner to the add-wizard options list. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 9/9 changed files
- Comments generated: 1
- Review effort level: Low
| cmd.Flags().Bool("create-issue", false, "Open a GitHub issue in each org repository with agentic workflows (requires --org)") | ||
| cmd.Flags().BoolP("yes", "y", false, "Auto-accept org-mode create confirmations (required in CI)") | ||
| cmd.Flags().BoolP("yes", "y", false, "Auto-accept org-mode upgrade confirmations (required in CI)") | ||
| cmd.Flags().Bool("audit", false, "Check dependency health without performing upgrades") |
There was a problem hiding this comment.
Already addressed by 9843669, which updates docs/src/content/docs/setup/cli.md to say org-mode upgrade confirmations in the gh aw upgrade section. I re-ran make fmt, make lint, make test-unit, make test, make recompile, and make agent-report-progress locally on the current branch and they all passed.
🤖 Triage Assessment
Summary: Fixes 3 CLI consistency issues across 9 commands — Next: Batch with other low-risk CLI/docs PRs or fast-track as standalone — nearly auto-merge quality.
|
|
@copilot please run the
|
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Addressed the unresolved docs inconsistency in |
|
@copilot please run the
|
The outstanding review note was already satisfied by |
|
@copilot please run the
|
No additional code changes were needed beyond |
|
@copilot please run the Unresolved review threads to address (newest first):
|
No additional code changes were needed in this pass: the unresolved docs feedback was already fixed by |
|
@copilot please run the
|
No further code changes were needed. The only review thread was already answered on-thread, and the docs fix remains in |
|
\n@copilot please run the skill, make this PR merge-ready, address all unresolved review feedback, and rerun checks once the branch is up to date.
|
🤖 PR Triage (updated)
Rationale: CI passing, low-risk CLI doc fix (12+/12−, 9 files). Promoted from Run §28909358158
|
|
🎉 This pull request is included in a new release. Release: |
Three CLI consistency issues found by automated inspection: wrong verb in
--yesflag descriptions forupdate/upgrade,$GH_AW_WORKFLOWS_DIRsilently omitted from--dirhelp text in 9 commands, and two flags missing from theadd-wizarddocs section.Changes
--yesflag verb mismatch (update_command.go,upgrade_command.go)Both commands copied the
deploydescription verbatim and said"create confirmations".update: →"Auto-accept org-mode update confirmations"upgrade: →"Auto-accept org-mode upgrade confirmations"--dirflag missing env var hint (9 commands)GetWorkflowDir()reads$GH_AW_WORKFLOWS_DIRfor all commands, but onlylintandlistsurfaced this in help text. Updated the remaining 9 to match:Affected:
compile,remove(cmd/gh-aw/main.go),validate,fix,add,add-wizard,deploy,update,upgrade.add-wizarddocs missing two flags (docs/src/content/docs/setup/cli.md)--appendand--no-security-scannerexist in the CLI but were absent from the Options table. Added both to match theaddcommand's documented options.pr-sous-chef run: https://github.com/github/gh-aw/actions/runs/28907709886