fix: CLI consistency — secrets bootstrap engine list, ghes flag punctuation, docs description - #48659
Conversation
…n, compile --ghes period Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅ |
|
✅ PR Code Quality Reviewer completed the code quality review. |
|
✅ Design Decision Gate 🏗️ completed the design decision gate check. No ADR enforcement needed: PR #48659 does not have the 'implementation' label and has only 1 new line of code in business logic directories (threshold: 100). |
There was a problem hiding this comment.
Pull request overview
Aligns CLI help and documentation with supported behavior.
Changes:
- Lists all seven supported bootstrap engines.
- Corrects the bootstrap documentation.
- Standardizes
--ghespunctuation.
Show a summary per file
| File | Description |
|---|---|
pkg/cli/tokens_bootstrap.go |
Reuses the shared engine help list. |
docs/src/content/docs/setup/cli.md |
Removes an unsupported validation claim. |
cmd/gh-aw/main.go |
Adds missing terminal punctuation. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 changed files
- Comments generated: 1
- Review effort level: Medium
|
|
||
| cmd.Flags().BoolVar(&nonInteractiveFlag, "non-interactive", false, "Check secrets without prompting (display-only mode)") | ||
| cmd.Flags().StringVarP(&engineFlag, "engine", "e", "", "Check tokens for specific engine (copilot, claude, codex, gemini)") | ||
| cmd.Flags().StringVarP(&engineFlag, "engine", "e", "", "Check tokens for specific engine ("+engineFlagHelpList+")") |
There was a problem hiding this comment.
Updated in commit test: strengthen bootstrap --engine flag test to cover full engine list. Renamed TestSecretsBootstrapEngineFlagIncludesGemini → TestSecretsBootstrapEngineFlagUsage and asserts all 7 engines (copilot, claude, codex, gemini, antigravity, opencode, pi) so future engine list drift is caught.
|
✅ Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. Test Quality Sentinel skipped. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Approve
Small, accurate consistency fix — no issues found.
Details
All three changes are verified correct against the codebase:
--enginehelp text now uses the sharedengineFlagHelpListconstant (copilot, claude, codex, gemini, antigravity, opencode, pi), matching whatgetSecretRequirementsForEngine/GetEngineOptionactually support.- Docs description for
secrets bootstrapno longer makes the unverified "validates tokens before uploading" claim. --ghesflag help text gains a trailing period for consistency with adjacent sentences.
Build passes (go build ./pkg/cli/... ./cmd/...). No logic changes, no behavior changes, no test impact expected.
🔎 Code quality review by PR Code Quality Reviewer · sonnet50 · 10 AIC · ⌖ 4.25 AIC · ⊞ 7.4K
Comment /review to run again
There was a problem hiding this comment.
The three changes are clean, minimal, and accurate:
tokens_bootstrap.go: Replaces stale hardcoded engine list with the sharedengineFlagHelpListconstant, consistent with other flag usages inflags.go.main.go: Trailing period added for punctuation consistency.docs/src/content/docs/setup/cli.md: Removes unverified claim; replacement text accurately reflects what the command does.
No issues found.
🧵 Reviewed using Impeccable skills by Impeccable Skills Reviewer · sonnet46 · 15.2 AIC · ⌖ 4.54 AIC · ⊞ 5K
There was a problem hiding this comment.
Skills-Based Review 🧠
Applied /grill-with-docs — all three changes are accurate and consistent with the codebase. No blocking issues.
📋 Key Themes & Highlights
Key Themes
- Engine list sync:
tokens_bootstrap.gonow uses the sharedengineFlagHelpListconstant — single source of truth, no more stale copy. - Docs accuracy: Removed the unverified "validates tokens before uploading" claim; new phrasing matches the CLI's own long description.
- Punctuation consistency:
--ghesflag description now ends with a period, matching the surrounding sentences.
Positive Highlights
- ✅ Using
engineFlagHelpListconstant prevents future drift between help text and supported engines. - ✅ Replacing a false claim with a verifiable one improves user trust in the docs.
- ✅ All changes are surgical — no collateral edits.
🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · sonnet46 · 22.7 AIC · ⌖ 6.4 AIC · ⊞ 6.7K
Comment /matt to run again
|
@copilot run pr-finisher skill |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Automated CLI consistency inspection flagged three issues: the
secrets bootstrap --enginehelp text listed only 4 engines while the underlying code (and docs) supported 7; the docs description contained an unverified "validates tokens before uploading" claim; andcompile --gheswas missing a trailing period on its last sentence.Changes
pkg/cli/tokens_bootstrap.go— Replace hardcoded(copilot, claude, codex, gemini)in the--engineflag description with the sharedengineFlagHelpListconstant (copilot, claude, codex, gemini, antigravity, opencode, pi).getSecretRequirementsForEnginealready handles all 7 viaGetEngineOption; only the help text was stale.docs/src/content/docs/setup/cli.md— Remove the unverified "validates tokens before uploading to the repository" claim from thesecrets bootstrapdescription; replace with accurate phrasing that matches the CLI's own long description.cmd/gh-aw/main.go— Add missing trailing period to the--ghesflag's third sentence ("Overrides the aw.json ghes field."), consistent with the preceding two sentences.Run: https://github.com/github/gh-aw/actions/runs/30375513874