Tighten CLI help/docs consistency for global options, forecast, and repo flag semantics - #50016
Merged
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix CLI consistency issues in help output
Tighten CLI help/docs consistency for global options, forecast, and repo flag semantics
Aug 3, 2026
pelikhan
approved these changes
Aug 3, 2026
pelikhan
marked this pull request as ready for review
August 3, 2026 16:57
Copilot stopped reviewing on behalf of
pelikhan due to an error
August 3, 2026 16:57
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot could not run the full agentic suite for this review because it was automatically requested on a bot-authored pull request. Request a review from Copilot under Reviewers to retry with the full agentic suite. Improved support for bot-authored pull requests is coming soon.
Updates CLI help and documentation to explicitly state that --repo flags accept only owner/repo (no GHES host prefixes) and adjusts docs/tests to enforce consistent help output.
Changes:
- Clarify
--repoflag usage text forenvanddoctorcommands to document the narrower accepted format. - Add/extend tests that assert help/docs include the new “owner/repo format only” wording (and include
forecast --concurrencyin docs). - Fix markdown formatting in
cli.mdso the global options table remains contiguous.
Show a summary per file
| File | Description |
|---|---|
| pkg/cli/env_command_test.go | Adds assertions that env get/update --repo help documents the narrower repo format. |
| pkg/cli/env_command.go | Updates --repo flag usage text to mention “owner/repo format only” and no GHES host prefixes. |
| pkg/cli/doctor_command_test.go | Adds assertion that doctor --repo help documents the narrower repo format. |
| pkg/cli/doctor_command.go | Updates doctor --repo flag usage text to mention “owner/repo format only” and no GHES host prefixes. |
| pkg/cli/cli_consistency_help_test.go | Ensures rendered docs include new repo-format notes, --concurrency option, and contiguous global options table. |
| docs/src/content/docs/setup/cli.md | Adds repo-format notes for doctor and env, adds --concurrency to forecast options, and moves prose out of the global options table. |
| .github/skills/agentic-workflows/SKILL.md | Adds a new referenced token-optimization observability doc to the skill checklist. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 7/7 changed files
- Comments generated: 2
- Review effort level: Lite
| assert.NotNil(t, cmd.Flags().Lookup("dir"), "should expose --dir flag") | ||
| assert.NotNil(t, cmd.Flags().Lookup("require-owner-type"), "should expose --require-owner-type flag") | ||
| assert.False(t, cmd.HasSubCommands()) | ||
| assert.Contains(t, cmd.Flags().Lookup("repo").Usage, "owner/repo format only", "doctor --repo help should explicitly document its narrower repo format") |
| } | ||
|
|
||
| cmd.Flags().StringP("repo", "r", "", "Target repository (owner/repo format)") | ||
| cmd.Flags().StringP("repo", "r", "", "Target repository (owner/repo format only; GHES host prefixes are not supported)") |
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 setup docs had one rendering break and one missing real flag, and
--reposemantics were ambiguous across commands. This change aligns the published docs and command help with the current behavior instead of leaving GHES support implied where it is not actually accepted.Docs rendering
docs/src/content/docs/setup/cli.mdby moving the nested-command-help note out of the table body so all option rows render as a single table.Forecast docs
--concurrencyoption to the documentedforecastcommand options list.--reposemantics made explicitdoctorandenvhelp text that these commands currently acceptowner/repoonly.GH_HOST, not[HOST/]owner/repoprefixes.Regression coverage
forecast --concurrencyowner/repo-only wording fordoctorandenv