Skip to content

Align CLI/workflow package specs with actual public surface #27461

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 2 commits into from
Apr 20, 2026
+6 −2
Merged

Align CLI/workflow package specs with actual public surface #27461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
888cd7d
Initial plan
Copilot Apr 20, 2026
c831a68
docs: fix spec audit mismatches for cli and workflow readmes
Copilot Apr 20, 2026
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
6 changes: 5 additions & 1 deletion pkg/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ All diagnostic output MUST go to `stderr` using `console` formatting helpers. St
|---------|-------------|-------------|
| `gh aw add` | `NewAddCommand` | Add remote or local workflows to the repository |
| `gh aw add-wizard` | `NewAddWizardCommand` | Interactive wizard for adding workflows |
| `gh aw new` | `newCmd` (main.go) | Create a new workflow file (supports `--force`, `--interactive`, `--engine`) |
| `gh aw compile` | (compile_command.go) | Compile `.md` workflow files into GitHub Actions `.lock.yml` |
| `gh aw enable` | `enableCmd` (main.go) | Enable a workflow |
| `gh aw disable` | `disableCmd` (main.go) | Disable a workflow |
Comment on lines +21 to +22
| `gh aw run` | `RunWorkflowOnGitHub` (main.go) | Dispatch and monitor workflow runs |
| `gh aw audit` | `NewAuditCommand` | Audit a specific workflow run by run ID |
| `gh aw audit diff` | `NewAuditDiffSubcommand` | Diff audit data between multiple runs |
Expand Down Expand Up @@ -47,7 +50,8 @@ All diagnostic output MUST go to `stderr` using `console` formatting helpers. St
| `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 |
| `gh aw trial` | `NewTrialCommand` | Run trial workflow executions |
| `gh aw deps` | (deps_*.go) | Dependency inspection and security advisories |
| _No `gh aw deps` command_ | `deps_*.go` (internal utilities) | Dependency reporting/advisory helpers used by other commands |
| `gh aw version` | `versionCmd` (main.go) | Show version information |
| `gh aw completion` | `NewCompletionCommand` | Generate shell completion scripts |

## Public API
Expand Down
2 changes: 1 addition & 1 deletion pkg/workflow/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The package is intentionally large (~320 source files) because it encodes all Gi
| `WithFailFast(bool)` | Stop at first validation error |
| `WithWorkflowIdentifier(string)` | Set the workflow identifier |
| `NewCompiler(opts ...CompilerOption)` | Creates a new `Compiler` |
| `NewCompilerWithVersion(string)` | Creates a `Compiler` with a specific version |
| `WithVersion(string) CompilerOption` | Sets a specific compiler version |

### Engine Architecture

Expand Down
Loading