[instructions] Sync github-agentic-workflows.md with v0.68.3#26400
[instructions] Sync github-agentic-workflows.md with v0.68.3#26400
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
utafrali
left a comment
There was a problem hiding this comment.
The import-field merge-behavior table and the two new flags are a useful addition, but the last bullet in the fields list omits merge semantics for seven fields, breaking the consistent pattern established by every other entry. The --approve rename also needs a migration note to avoid silently breaking existing scripts.
| - `on.github-app:` - Activation GitHub App credentials (first-wins across imports) | ||
| - `steps:`, `pre-steps:`, `post-steps:` - Steps appended in import order | ||
| - `runtimes:`, `network:`, `permissions:`, `services:`, `cache:`, `features:`, `mcp-servers:` | ||
|
|
There was a problem hiding this comment.
This line lists seven fields without describing their merge behavior, which is inconsistent with every other entry in this list. All sibling bullets explicitly describe their semantics (last-wins, first-wins, appended, etc.). A reader cannot infer merge behavior for fields like permissions: or network: without this detail. Consider expanding to something like:
- `runtimes:`, `network:`, `permissions:`, `services:`, `cache:`, `features:`, `mcp-servers:` - Last import wins; main workflow takes precedence
or split them if their merge strategies differ.
| gh aw compile --validate-images | ||
|
|
||
| # Approve all safe update changes (new secrets, action additions/removals not in manifest) | ||
| gh aw compile --approve |
There was a problem hiding this comment.
The --approve flag is documented here as if it is new, but per the PR description and PR #26160 it is a rename of --safe-update. Any existing script or workflow that passes --safe-update will silently or loudly break after upgrading without knowing where to look. Adding a parenthetical like (formerly --safe-update) gives readers a clear migration path.
| gh aw compile --runner-guard # Runner constraint scanner (requires Docker) | ||
|
|
||
| # Require Docker for container image validation (silently skipped without this flag when Docker is unavailable) | ||
| gh aw compile --validate-images |
There was a problem hiding this comment.
The parenthetical (silently skipped without this flag when Docker is unavailable) is ambiguous. It could be read as: validation is skipped when (a) the flag is absent OR (b) Docker is unavailable, or that both conditions must hold simultaneously. The intended meaning is that the flag opts in to making Docker required, and the old default was a silent skip. A clearer phrasing would be:
# Enable container image validation; requires Docker (without this flag, validation is silently skipped when Docker is unavailable)
Instructions Update - Synchronized with v0.68.3
This PR updates
github-agentic-workflows.mdbased on code changes shipped in v0.68.3.Changes Made
--validate-images(opt-in Docker container image validation; previously skipped silently when Docker was unavailable) and--approve(renamed from--safe-update, approves all safe update changes including new secrets and action additions/removals)env:,checkout:,github-app:,on.github-app:, and others), with an updated example showingenv:andcheckout:in practiceDocumentation Commits Reviewed
Safe-Outputs Code Audit
compiler_types.goandsafe_outputs_config.go— all safe-output types and global configuration fields already documented in the instructions; no gaps foundRelease Notes Items Addressed
--validate-imagesflag (PR Skip Docker image validation when Docker is unavailable, add --validate-images flag #26074: "Skip Docker image validation when Docker is unavailable, add --validate-images flag")--approveflag (PR fix: rename --safe-update to --approve and improve safe update UX #26160: "--safe-updaterenamed to--approve")checkoutfield in shared imports (PR feat: support checkout field in importable shared workflows #26292: "feat: support checkout field in importable shared workflows")envfield in shared imports (PR feat: supportenvfield in shared imports #26113: "feat: support env field in shared imports")github-appas Allowed Import Field (PR docs: addgithub-appto Allowed Import Fields in imports reference #26119: "docs: addgithub-appto Allowed Import Fields")Validation
compiler_types.go,safe_outputs_config.go,cmd/gh-aw/main.go,pkg/parser/import_field_extractor.go)