Skip to content

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

Merged
pelikhan merged 1 commit intomainfrom
spec-extractor/run-1-constants-cli-console-agentdrain-e45a4b9c522bb7fe
Apr 17, 2026
Merged

[spec-extractor] Update package specifications for constants, cli (run 1)#26841
pelikhan merged 1 commit intomainfrom
spec-extractor/run-1-constants-cli-console-agentdrain-e45a4b9c522bb7fe

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Package Specification Updates

This PR updates README.md specifications for the following packages, analyzed during spec-extractor run 1.

Package Status Changes
constants Updated Added Crush engine, new feature flags, model env vars, version/port constants
cli Updated Added secrets set and secrets bootstrap subcommand entries
console Unchanged README already comprehensive and accurate
agentdrain Unchanged README already comprehensive and accurate

What Changed

pkg/constants/README.md

  • Engine Constants: Added CrushEngine ("crush") and updated AgenticEngines to include it
  • Feature Flags: Added 3 new flags: AwfDiagnosticLogsFeatureFlag ("awf-diagnostic-logs"), ByokCopilotFeatureFlag ("byok-copilot"), MCPCLIFeatureFlag ("mcp-cli")
  • Model Env Vars: Added EnvVarModelAgentCrush, EnvVarModelDetectionCrush, CrushCLIModelEnvVar
  • Version Constants: Added DefaultCrushVersion
  • Network Port Constants: Added CrushLLMGatewayPort (10004)

pkg/cli/README.md

  • Added gh aw secrets set subcommand entry (Create or update a repository secret)
  • Added gh aw secrets bootstrap subcommand entry (Validate and configure all required secrets)

Extraction Method

  • Source code analysis of exported symbols, types, and constants
  • Cross-referenced with existing README content to avoid overwriting accurate sections
  • Verified all constants against pkg/constants/*.go source files

Round-Robin State

  • Packages processed this run: agentdrain, cli, console, constants
  • Next packages in rotation: envutil, fileutil, gitutil, logger
  • Total packages: 20
  • Coverage: All 20 packages already have specifications; this run refreshes 4

Auto-generated by Package Specification Extractor workflow

Generated by Package Specification Extractor · ● 4.9M ·

  • expires on Apr 20, 2026, 10:45 AM UTC

- constants: add CrushEngine, AgenticEngines update, 3 new feature flags
  (AwfDiagnosticLogsFeatureFlag, ByokCopilotFeatureFlag, MCPCLIFeatureFlag),
  Crush model env vars, DefaultCrushVersion, CrushLLMGatewayPort
- cli: add secrets set and secrets bootstrap subcommand entries

Co-authored-by: Copilot <[email protected]>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation pkg-specifications labels Apr 17, 2026
Copy link
Copy Markdown

@utafrali utafrali left a comment

Choose a reason for hiding this comment

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

The constants additions look structurally correct and follow existing patterns well, but the CLI README has two problems worth fixing: the secrets bootstrap entry incorrectly references secret_set_command.go (almost certainly the wrong file), and both new rows break the table's constructor-name convention by using file paths instead.

Comment thread pkg/cli/README.md
| `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 |
| `gh aw secrets bootstrap` | (secret_set_command.go) | Validate and configure all required secrets for workflows |
Copy link
Copy Markdown

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.

Comment thread pkg/cli/README.md
| `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

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.

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

Copy link
Copy Markdown

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.

@pelikhan pelikhan merged commit 9507c2b into main Apr 17, 2026
84 checks passed
@pelikhan pelikhan deleted the spec-extractor/run-1-constants-cli-console-agentdrain-e45a4b9c522bb7fe branch April 17, 2026 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation pkg-specifications

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants