Skip to content

[cli-consistency] Verify Short descriptions don't end with periods (CLI convention check) #9946

@github-actions

Description

@github-actions

Issue Description

Commands: gh aw compile, gh aw enable, gh aw disable, and others
Type: Minor command description ending punctuation inconsistency
Priority: Low

Current Behavior

Examining /home/runner/work/gh-aw/gh-aw/cmd/gh-aw/main.go shows inconsistent use of periods at the end of Short command descriptions:

Commands WITHOUT periods (correct per CLI conventions):

  • newCmd.Short: "Create a new workflow Markdown file with example configuration"
  • removeCmd.Short: "Remove agentic workflow files matching the given name prefix"
  • enableCmd.Short: "Enable agentic workflows"
  • disableCmd.Short: "Disable agentic workflows and cancel any in-progress runs"
  • compileCmd.Short: "Compile agentic workflows from Markdown to GitHub Actions YAML"
  • runCmd.Short: "Run one or more agentic workflows on GitHub Actions"
  • versionCmd.Short: "Show gh aw extension version information"

Commands WITH periods (non-standard):
None found in main.go root commands

Issue

The consistency is actually GOOD here - all Short descriptions properly omit the trailing period, which follows CLI best practices. However, checking subcommands in /home/runner/work/gh-aw/gh-aw/pkg/cli/:

Status command (status_command.go): Would need to verify
MCP command (mcp.go): Would need to verify
Audit command (audit.go): Would need to verify
Logs command (logs_command.go): Would need to verify

Suggested Action

Run the following grep to find any Short: fields that end with periods:

grep -r 'Short:.*\."$' pkg/cli/ cmd/gh-aw/

Then update any found instances to remove trailing periods for consistency with Cobra/CLI conventions.

Note

If all commands already follow this convention (which appears to be the case from spot-checking), this issue can be closed as "no action needed".

AI generated by CLI Consistency Checker

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions