Clarify status/list pattern semantics and add CLI help example validation#34018
Merged
Conversation
10 tasks
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
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] Improve help text consistency in CLI commands
Clarify May 22, 2026
status/list pattern semantics and add CLI help example validation
pelikhan
approved these changes
May 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies CLI help text for status/list pattern semantics and introduces a unit test that validates gh aw ... examples embedded in Cobra help output.
Changes:
- Refines
statusandlistlong help descriptions for the optional[pattern]argument. - Adds a non-integration test that extracts
gh aw ...examples from command help text and validates referenced commands/flags. - Updates action pin/lock artifacts to pin
docker/metadata-actionat thev6major tag SHA.
Show a summary per file
| File | Description |
|---|---|
pkg/cli/status.go |
Updates status help text to further describe [pattern] input forms. |
pkg/cli/list_workflows_command.go |
Updates list help text to further describe [pattern] input forms. |
cmd/gh-aw/help_examples_test.go |
Adds a unit test that parses help examples and validates command/flag correctness. |
pkg/workflow/data/action_pins.json |
Adds a docker/metadata-action@v6 pin entry. |
pkg/actionpins/data/action_pins.json |
Adds a docker/metadata-action@v6 pin entry (duplicate data set). |
.github/aw/actions-lock.json |
Adds a docker/metadata-action@v6 pin entry for the repo’s lock file. |
.github/workflows/release.lock.yml |
Updates the pinned docker/metadata-action SHA used by the release workflow. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 7/7 changed files
- Comments generated: 3
Comment on lines
+32
to
+34
| appendFromLine := func(line string) { | ||
| withoutComment := strings.TrimSpace(strings.SplitN(line, "#", 2)[0]) | ||
| if withoutComment == "" { |
| and time remaining until expiration (if stop-after is configured). | ||
|
|
||
| The optional pattern argument filters workflows by name (case-insensitive substring match). | ||
| It accepts workflow IDs (basename without .md) or full filenames. |
| Unlike 'status', this command does not check GitHub workflow state or time remaining. | ||
|
|
||
| The optional pattern argument filters workflows by name (case-insensitive substring match). | ||
| It accepts workflow IDs (basename without .md) or full filenames. |
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.
CLI consistency review flagged ambiguity in
status/listaround what[pattern]accepts and identified the lack of automated validation for help examples. This PR tightens command help language and adds a focused test to continuously validate example correctness.Help text consistency (
status,list)[pattern]is a case-insensitive name filter..md) or full filename.Automated help-example validation
cmd/gh-aw/help_examples_test.go) that:gh aw ...examples from command help text,Example of the new wording