Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/gh-aw/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -709,7 +709,7 @@ Use "` + string(constants.CLIExtensionPrefix) + ` help all" to show help for all
compileCmd.Flags().Bool("stats", false, "Display statistics table sorted by workflow file size (shows jobs, steps, scripts, and shells)")
compileCmd.Flags().Bool("fail-fast", false, "Stop at the first validation error instead of collecting all errors")
compileCmd.Flags().Bool("no-check-update", false, "Skip checking for gh-aw updates")
compileCmd.Flags().String("schedule-seed", "", "Override the repository slug (owner/repo) used as seed for fuzzy schedule scattering (e.g. \"github/gh-aw\"). Bypasses git remote detection entirely. Use this when your git remote is not named \"origin\" and you have multiple remotes configured")
compileCmd.Flags().String("schedule-seed", "", "Override the repository slug (owner/repo) used as seed for fuzzy schedule scattering (e.g., \"github/gh-aw\"). Bypasses git remote detection entirely. Use this when your git remote is not named \"origin\" and you have multiple remotes configured")
compileCmd.Flags().Bool("staged", false, "Force all safe-outputs into staged mode")
compileCmd.Flags().Bool("approve", false, "Approve all safe update changes. When strict mode is active (the default), the compiler emits warnings for new restricted secrets or unapproved action additions/removals not present in the existing gh-aw-manifest. Use this flag to approve and skip safe update enforcement")
compileCmd.Flags().Bool("validate-images", false, "Require Docker to be available for container image validation. Without this flag, container image validation is silently skipped when Docker is not installed or the daemon is not running")
Expand Down
1 change: 1 addition & 0 deletions cmd/gh-aw/main_help_text_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ func TestCompileScheduleSeedHelpUsesConsistentQuotes(t *testing.T) {
require.NotNil(t, scheduleSeedFlag, "compile command should define --schedule-seed")
assert.Contains(t, scheduleSeedFlag.Usage, "\"github/gh-aw\"", "--schedule-seed example should use double quotes")
assert.Contains(t, scheduleSeedFlag.Usage, "\"origin\"", "--schedule-seed remote example should use double quotes")
assert.Contains(t, scheduleSeedFlag.Usage, "(e.g.,", "--schedule-seed example should use standard e.g., punctuation")
}

func TestCompileStagedFlagHelpText(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/setup/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -764,7 +764,7 @@ gh aw domains weekly-research --json # Output workflow domains in JSON format

**Options:** `--json/-j`

When no workflow is specified, lists all workflows with a summary of allowed and blocked domain counts. When a workflow is specified, lists all effective allowed and blocked domains including domains expanded from ecosystem identifiers (e.g. `node`, `python`, `github`) and engine defaults.
When no workflow is specified, lists all workflows with a summary of allowed and blocked domain counts. When a workflow is specified, lists all effective allowed and blocked domains including domains expanded from ecosystem identifiers (e.g., `node`, `python`, `github`) and engine defaults.

### Utility Commands

Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/checks_command.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Maps PR check rollups to one of the following normalized states:
JSON output includes two state fields:
state - aggregate state across all check runs and commit statuses
required_state - state derived from check runs and policy commit statuses only;
ignores optional third-party commit statuses (e.g. Vercel,
ignores optional third-party commit statuses (e.g., Vercel,
Netlify deployments) but still surfaces policy_blocked when
branch-protection or account-gate statuses fail

Expand Down
7 changes: 7 additions & 0 deletions pkg/cli/cli_consistency_help_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,10 @@ func TestSubcommandListingsUseHyphenBullets(t *testing.T) {
})
}
}

func TestHelpTextUsesStandardEgPunctuation(t *testing.T) {
assert.Contains(t, coolDownFlagUsage, "(e.g., 7d", "--cool-down help should use e.g., punctuation")
assert.Contains(t, NewEnvCommand().Long, "(e.g., default_max_turns)", "env help should use e.g., punctuation")
assert.Contains(t, NewDomainsCommand().Long, "(e.g., \"node\", \"python\", \"github\")", "domains help should use e.g., punctuation")
assert.Contains(t, NewChecksCommand().Long, "(e.g., Vercel,", "checks help should use e.g., punctuation")
}
2 changes: 1 addition & 1 deletion pkg/cli/domains_command.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ and blocked domain counts.

When a workflow ID or file is specified, lists all effective allowed and blocked
domains for that workflow, including domains expanded from ecosystem identifiers
(e.g. "node", "python", "github") and engine defaults.
(e.g., "node", "python", "github") and engine defaults.

The workflow argument can be:
- A workflow ID (basename without .md extension, e.g., "weekly-research")
Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/env_command.go
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ func NewEnvCommand() *cobra.Command {
Short: "Manage compiler defaults as GitHub variables",
Long: `Manage compiler default variables in batch for repository, organization, or enterprise scope.

The YAML file is flat and uses default_-prefixed lowercase keys (e.g. default_max_turns).
The YAML file is flat and uses default_-prefixed lowercase keys (e.g., default_max_turns).
Set a field to null (or omit it) in update mode to delete the variable from the selected scope.
Any field with a non-null string value will be set or updated.`,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/mcp_tools_readonly.go
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ Maps PR check rollups to one of the following normalized states:
Returns JSON with two state fields:
state - aggregate state across all check runs and commit statuses
required_state - state derived from check runs and policy commit statuses only;
ignores optional third-party commit statuses (e.g. Vercel,
ignores optional third-party commit statuses (e.g., Vercel,
Netlify deployments) but still surfaces policy_blocked when
branch-protection or account-gate statuses fail

Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/update_cooldown.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (

var cooldownLog = logger.New("cli:update_cooldown")

const coolDownFlagUsage = "Cooldown period before applying a new release (e.g. 7d, 24h, 0 to disable). Does not apply to actions/* or github/* repositories"
const coolDownFlagUsage = "Cooldown period before applying a new release (e.g., 7d, 24h, 0 to disable). Does not apply to actions/* or github/* repositories"

// parseCoolDownFlag parses a cooldown duration string.
// Accepts day-suffix notation ("7d") or Go duration format ("168h", "0").
Expand Down