Skip to content

fix: correct --yes verb, --dir env hint, and add-wizard docs across 9 commands#44050

Merged
pelikhan merged 4 commits into
mainfrom
copilot/cli-consistency-issues-resolution
Jul 8, 2026
Merged

fix: correct --yes verb, --dir env hint, and add-wizard docs across 9 commands#44050
pelikhan merged 4 commits into
mainfrom
copilot/cli-consistency-issues-resolution

Conversation

Copilot AI commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Three CLI consistency issues found by automated inspection: wrong verb in --yes flag descriptions for update/upgrade, $GH_AW_WORKFLOWS_DIR silently omitted from --dir help text in 9 commands, and two flags missing from the add-wizard docs section.

Changes

--yes flag verb mismatch (update_command.go, upgrade_command.go)

Both commands copied the deploy description verbatim and said "create confirmations".

  • update: → "Auto-accept org-mode update confirmations"
  • upgrade: → "Auto-accept org-mode upgrade confirmations"

--dir flag missing env var hint (9 commands)

GetWorkflowDir() reads $GH_AW_WORKFLOWS_DIR for all commands, but only lint and list surfaced this in help text. Updated the remaining 9 to match:

-d, --dir string   Workflow directory (default: $GH_AW_WORKFLOWS_DIR or .github/workflows)

Affected: compile, remove (cmd/gh-aw/main.go), validate, fix, add, add-wizard, deploy, update, upgrade.

add-wizard docs missing two flags (docs/src/content/docs/setup/cli.md)

--append and --no-security-scanner exist in the CLI but were absent from the Options table. Added both to match the add command's documented options.


Generated by 👨‍🍳 PR Sous Chef · 4.03 AIC · ⌖ 8.11 AIC · ⊞ 7.1K ·
Comment /souschef to run again


Generated by 👨‍🍳 PR Sous Chef · 10.1 AIC · ⌖ 5.64 AIC · ⊞ 4.7K ·
Comment /souschef to run again


Generated by 👨‍🍳 PR Sous Chef · 7.79 AIC · ⌖ 6.55 AIC · ⊞ 7.1K ·
Comment /souschef to run again


Generated by 👨‍🍳 PR Sous Chef · 8.05 AIC · ⌖ 8.96 AIC · ⊞ 7.1K ·
Comment /souschef to run again


Generated by 👨‍🍳 PR Sous Chef · 9.66 AIC · ⌖ 5.93 AIC · ⊞ 7.1K ·
Comment /souschef to run again


pr-sous-chef run: https://github.com/github/gh-aw/actions/runs/28907709886

Generated by 👨‍🍳 PR Sous Chef · 13 AIC · ⌖ 12.3 AIC · ⊞ 7.1K ·
Comment /souschef to run again

…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>
Copilot AI changed the title [WIP] Fix CLI consistency issues identified in inspection fix: correct --yes verb, --dir env hint, and add-wizard docs across 9 commands Jul 7, 2026
Copilot AI requested a review from pelikhan July 7, 2026 14:50
@pelikhan pelikhan marked this pull request as ready for review July 7, 2026 16:53
Copilot AI review requested due to automatic review settings July 7, 2026 16:53

Copilot AI 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.

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/-y help text verbs for update and upgrade to match what the commands actually do.
  • Updated --dir/-d help text across commands to include the $GH_AW_WORKFLOWS_DIR environment variable hint.
  • Updated add-wizard docs to include --append and --no-security-scanner in 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

Comment on lines 160 to 162
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")

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

🤖 Triage Assessment

Field Value
Category chore
Risk 🟢 Low
Score 52/100 (Impact 22 + Urgency 15 + Quality 15)
Action batch_review · batch: pr-batch:cli-consistency

Summary: Fixes 3 CLI consistency issues across 9 commands — --yes verb wording, $GH_AW_WORKFLOWS_DIR in --dir help, and add-wizard docs. Small diff (+12/−12, 9 files). CI passing (build + Windows integration). Bot reviewer commented (no CHANGES_REQUESTED). Clean state.

Next: Batch with other low-risk CLI/docs PRs or fast-track as standalone — nearly auto-merge quality.

Generated by 🔧 PR Triage Agent · 97.9 AIC · ⌖ 12.4 AIC · ⊞ 5.4K ·

@gh-aw-bot

Copy link
Copy Markdown
Collaborator

@copilot please run the pr-finisher skill, address unresolved review comments, and rerun checks once the branch is up to date.
Unresolved review threads to address:

Generated by 👨‍🍳 PR Sous Chef · 4.03 AIC · ⌖ 8.11 AIC · ⊞ 7.1K ·
Comment /souschef to run again

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>

Copilot AI commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

@copilot please run the pr-finisher skill, address unresolved review comments, and rerun checks once the branch is up to date.
Unresolved review threads to address:

  • `@copilot-pull-request-reviewer...

Addressed the unresolved docs inconsistency in 9843669 by changing the upgrade docs text to say org-mode upgrade confirmations in docs/src/content/docs/setup/cli.md. Local make fmt, make lint, make test-unit, make test, make recompile, and make agent-report-progress all passed. I can’t re-trigger PR checks from this agent after pushing, so CI on the new HEAD still needs a maintainer to re-run.

Copilot AI requested a review from gh-aw-bot July 7, 2026 20:09
@gh-aw-bot

Copy link
Copy Markdown
Collaborator

@copilot please run the pr-finisher skill, address outstanding review feedback, and rerun checks once the branch is up to date.

Generated by 👨‍🍳 PR Sous Chef · 10.1 AIC · ⌖ 5.64 AIC · ⊞ 4.7K ·
Comment /souschef to run again

Copilot AI commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

@copilot please run the pr-finisher skill, address outstanding review feedback, and rerun checks once the branch is up to date.

...

The outstanding review note was already satisfied by 9843669, which updates docs/src/content/docs/setup/cli.md to say org-mode upgrade confirmations. I verified the branch is up to date with origin/main, and local make fmt, make lint, make test-unit, make test, make recompile, and make agent-report-progress all passed with no additional diff. I can’t re-trigger GitHub Actions from this agent, so CI on 9843669 still needs a maintainer-triggered rerun before merge.

@gh-aw-bot

Copy link
Copy Markdown
Collaborator

@copilot please run the pr-finisher skill, make the PR merge-ready, and rerun checks once the branch is up to date.

Generated by 👨‍🍳 PR Sous Chef · 7.79 AIC · ⌖ 6.55 AIC · ⊞ 7.1K ·
Comment /souschef to run again

Copilot AI commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

@copilot please run the pr-finisher skill, make the PR merge-ready, and rerun checks once the branch is up to date.

...

No additional code changes were needed beyond 9843669; that commit already fixes the outstanding upgrade docs wording. I verified the branch is up to date with origin/main, and local make fmt, make lint, make test-unit, make test, and make recompile all passed. The remaining PR workflows on this head are GitHub-side action_required/stale, so a maintainer will need to re-trigger or approve CI before merge.

@gh-aw-bot

Copy link
Copy Markdown
Collaborator

@copilot please run the pr-finisher skill, make this PR merge-ready, address all unresolved review feedback, and rerun checks once the branch is up to date.

Unresolved review threads to address (newest first):

Generated by 👨‍🍳 PR Sous Chef · 8.05 AIC · ⌖ 8.96 AIC · ⊞ 7.1K ·
Comment /souschef to run again

Copilot AI commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

@copilot please run the pr-finisher skill, make this PR merge-ready, address all unresolved review feedback, and rerun checks once the branch is up to date.

Unresolved review threads to address (ne...

No additional code changes were needed in this pass: the unresolved docs feedback was already fixed by 9843669, and I replied on the review thread with the specific file update. I also re-ran make fmt, make lint, make test-unit, make test, make recompile, and make agent-report-progress locally; all passed. The PR is ready from the agent side, but GitHub Actions on this head still need a maintainer-triggered rerun before merge.

@gh-aw-bot

Copy link
Copy Markdown
Collaborator

@copilot please run the pr-finisher skill, make this PR merge-ready, address all unresolved review feedback, and rerun checks once the branch is up to date.

Generated by 👨‍🍳 PR Sous Chef · 9.66 AIC · ⌖ 5.93 AIC · ⊞ 7.1K ·
Comment /souschef to run again

Copilot AI commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

@copilot please run the pr-finisher skill, make this PR merge-ready, address all unresolved review feedback, and rerun checks once the branch is up to date.

...

No further code changes were needed. The only review thread was already answered on-thread, and the docs fix remains in 9843669. I re-ran make fmt, make lint, make test-unit, make test, make recompile, and make agent-report-progress locally; all passed with a clean worktree. What remains is GitHub-side: the review thread is still not marked resolved, and the non-copilot workflows on this head remain action_required/need a maintainer re-trigger or approval before merge.

@gh-aw-bot

Copy link
Copy Markdown
Collaborator

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

Generated by 👨‍🍳 PR Sous Chef · 13 AIC · ⌖ 12.3 AIC · ⊞ 7.1K ·
Comment /souschef to run again

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

🤖 PR Triage (updated)

Field Value
Category chore
Risk 🟢 Low
Score 56/100 (impact:20 urgency:18 quality:18)
Action auto_mergepromoted
Carry-over x2

Rationale: CI passing, low-risk CLI doc fix (12+/12−, 9 files). Promoted from batch_review to auto_merge. Merge or this becomes stale.

Run §28909358158

Generated by 🔧 PR Triage Agent · 112.1 AIC · ⌖ 6.5 AIC · ⊞ 5.4K ·

@pelikhan pelikhan merged commit 9c4e64a into main Jul 8, 2026
33 checks passed
@pelikhan pelikhan deleted the copilot/cli-consistency-issues-resolution branch July 8, 2026 01:52
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.82.4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[cli-consistency] CLI Consistency Issues - 2026-07-07

4 participants