Skip to content

[spec-extractor] Update package specifications for constants, cli (run 1) #26841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Apr 17, 2026
+12 −1
Merged

[spec-extractor] Update package specifications for constants, cli (run 1) #26841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions pkg/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ All diagnostic output MUST go to `stderr` using `console` formatting helpers. St
| `gh aw project` | `NewProjectCommand` | Project management helpers |
| `gh aw remove` | `NewRemoveCommand` | Remove workflow files from the repository |
| `gh aw secrets` | `NewSecretsCommand` | Manage workflow secrets |
| `gh aw secrets set` | (secret_set_command.go) | Create or update a repository secret |
Copy link
Copy Markdown

@utafrali utafrali Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new rows break the table's established convention for the middle column. Every other entry uses a Go constructor name (e.g. NewSecretsCommand, NewProjectCommand). The new entries use parenthesized file names like (secret_set_command.go) instead. If the extractor cannot determine the constructor name it should use a consistent placeholder (e.g. N/A) or leave the cell blank, not switch to a different identifier format mid-table.

| `gh aw secrets bootstrap` | (secret_set_command.go) | Validate and configure all required secrets for workflows |
Copy link
Copy Markdown

@utafrali utafrali Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

secrets bootstrap is attributed to (secret_set_command.go), which is almost certainly wrong. Bootstrap and set are distinct operations and would typically live in separate source files (e.g. secret_bootstrap_command.go). If both commands actually live in the same file, that is worth a separate note, but the auto-extractor should verify this rather than defaulting the bootstrap entry to the set command's file.

| `gh aw trial` | `NewTrialCommand` | Run trial workflow executions |
| `gh aw deps` | (deps_*.go) | Dependency inspection and security advisories |
| `gh aw completion` | `NewCompletionCommand` | Generate shell completion scripts |
Expand Down
11 changes: 10 additions & 1 deletion pkg/constants/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,11 @@ constants.CopilotEngine // "copilot"
constants.ClaudeEngine // "claude"
constants.CodexEngine // "codex"
constants.GeminiEngine // "gemini"
constants.CrushEngine // "crush"
constants.DefaultEngine // "copilot"

// All supported engine names
constants.AgenticEngines // []string{"claude", "codex", "copilot", "gemini"}
constants.AgenticEngines // []string{"claude", "codex", "copilot", "gemini", "crush"}

Copy link
Copy Markdown

@utafrali utafrali Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing AgenticEngines slice was documented in alphabetical order by engine name: ["claude", "codex", "copilot", "gemini"]. Alphabetically, "crush" (c-r) sorts before "gemini" (g), so the correct order would be []string{"claude", "codex", "copilot", "crush", "gemini"}. If the actual Go source appends "crush" at the end rather than inserting it in sorted position, the documentation is accurate but the Go slice itself is inconsistent with the prior ordering convention. Either way, this is worth a manual check against the source.

// Get engine metadata
opt := constants.GetEngineOption("copilot")
Expand Down Expand Up @@ -93,16 +94,19 @@ constants.EnvVarModelAgentClaude // "GH_AW_MODEL_AGENT_CLAUDE"
constants.EnvVarModelAgentCodex // "GH_AW_MODEL_AGENT_CODEX"
constants.EnvVarModelAgentCustom // "GH_AW_MODEL_AGENT_CUSTOM"
constants.EnvVarModelAgentGemini // "GH_AW_MODEL_AGENT_GEMINI"
constants.EnvVarModelAgentCrush // "GH_AW_MODEL_AGENT_CRUSH"
constants.EnvVarModelDetectionCopilot// "GH_AW_MODEL_DETECTION_COPILOT"
constants.EnvVarModelDetectionClaude // "GH_AW_MODEL_DETECTION_CLAUDE"
constants.EnvVarModelDetectionCodex // "GH_AW_MODEL_DETECTION_CODEX"
constants.EnvVarModelDetectionGemini // "GH_AW_MODEL_DETECTION_GEMINI"
constants.EnvVarModelDetectionCrush // "GH_AW_MODEL_DETECTION_CRUSH"

// Native CLI model env vars (passed directly to the engine CLI)
constants.CopilotCLIModelEnvVar // "COPILOT_MODEL"
constants.CopilotCLIIntegrationIDEnvVar // "GITHUB_COPILOT_INTEGRATION_ID"
constants.ClaudeCLIModelEnvVar // "ANTHROPIC_MODEL"
constants.GeminiCLIModelEnvVar // "GEMINI_MODEL"
constants.CrushCLIModelEnvVar // "CRUSH_MODEL"

// gh-aw runtime env vars
constants.EnvVarPrompt // "GH_AW_PROMPT"
Expand All @@ -127,7 +131,10 @@ constants.DisableXPIAPromptFeatureFlag // "disable-xpia-prompt"
constants.CopilotRequestsFeatureFlag // "copilot-requests"
constants.DIFCProxyFeatureFlag // "difc-proxy" (deprecated — use tools.github.integrity-proxy)
constants.CliProxyFeatureFlag // "cli-proxy"
constants.AwfDiagnosticLogsFeatureFlag // "awf-diagnostic-logs"
constants.ByokCopilotFeatureFlag // "byok-copilot"
constants.IntegrityReactionsFeatureFlag // "integrity-reactions"
constants.MCPCLIFeatureFlag // "mcp-cli"
```

## Job and Step Constants
Expand Down Expand Up @@ -230,6 +237,7 @@ constants.DefaultCopilotVersion // Copilot CLI version (e.g. "1.0.21")
constants.DefaultClaudeCodeVersion // Claude Code CLI version
constants.DefaultCodexVersion // OpenAI Codex CLI version
constants.DefaultGeminiVersion // Google Gemini CLI version
constants.DefaultCrushVersion // Crush CLI version

// Infrastructure
constants.DefaultGitHubMCPServerVersion // GitHub MCP server Docker image version
Expand Down Expand Up @@ -396,6 +404,7 @@ constants.ClaudeLLMGatewayPort // 10000
constants.CodexLLMGatewayPort // 10001
constants.CopilotLLMGatewayPort // 10002
constants.GeminiLLMGatewayPort // 10003
constants.CrushLLMGatewayPort // 10004
```

## Tool Lists
Expand Down