Skip to content

Commit c9e02cb

Browse files
authored
Align CLI/workflow package specs with actual public surface (#27461)
1 parent af5df47 commit c9e02cb

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

pkg/cli/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ All diagnostic output MUST go to `stderr` using `console` formatting helpers. St
1616
|---------|-------------|-------------|
1717
| `gh aw add` | `NewAddCommand` | Add remote or local workflows to the repository |
1818
| `gh aw add-wizard` | `NewAddWizardCommand` | Interactive wizard for adding workflows |
19+
| `gh aw new` | `newCmd` (main.go) | Create a new workflow file (supports `--force`, `--interactive`, `--engine`) |
1920
| `gh aw compile` | (compile_command.go) | Compile `.md` workflow files into GitHub Actions `.lock.yml` |
21+
| `gh aw enable` | `enableCmd` (main.go) | Enable a workflow |
22+
| `gh aw disable` | `disableCmd` (main.go) | Disable a workflow |
2023
| `gh aw run` | `RunWorkflowOnGitHub` (main.go) | Dispatch and monitor workflow runs |
2124
| `gh aw audit` | `NewAuditCommand` | Audit a specific workflow run by run ID |
2225
| `gh aw audit diff` | `NewAuditDiffSubcommand` | Diff audit data between multiple runs |
@@ -47,7 +50,8 @@ All diagnostic output MUST go to `stderr` using `console` formatting helpers. St
4750
| `gh aw secrets set` | (secret_set_command.go) | Create or update a repository secret |
4851
| `gh aw secrets bootstrap` | (secret_set_command.go) | Validate and configure all required secrets for workflows |
4952
| `gh aw trial` | `NewTrialCommand` | Run trial workflow executions |
50-
| `gh aw deps` | (deps_*.go) | Dependency inspection and security advisories |
53+
| _No `gh aw deps` command_ | `deps_*.go` (internal utilities) | Dependency reporting/advisory helpers used by other commands |
54+
| `gh aw version` | `versionCmd` (main.go) | Show version information |
5155
| `gh aw completion` | `NewCompletionCommand` | Generate shell completion scripts |
5256

5357
## Public API

pkg/workflow/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The package is intentionally large (~320 source files) because it encodes all Gi
4545
| `WithFailFast(bool)` | Stop at first validation error |
4646
| `WithWorkflowIdentifier(string)` | Set the workflow identifier |
4747
| `NewCompiler(opts ...CompilerOption)` | Creates a new `Compiler` |
48-
| `NewCompilerWithVersion(string)` | Creates a `Compiler` with a specific version |
48+
| `WithVersion(string) CompilerOption` | Sets a specific compiler version |
4949

5050
### Engine Architecture
5151

0 commit comments

Comments
 (0)