Skip to content

Commit 19523de

Browse files
[instructions] Sync instruction files with release v0.82.2 (#43990)
1 parent 0121fe6 commit 19523de

4 files changed

Lines changed: 7 additions & 19 deletions

File tree

.github/aw/create-agentic-workflow.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,13 +169,10 @@ Rules:
169169

170170
### 8. Add cost-aware triage and context flow
171171

172-
- For high-volume inputs, design a cheap triage step before expensive analysis.
173-
- Require explicit `noop` or safe-output behavior for known, duplicate, stale, or low-value cases.
174-
- Reserve frontier-model reasoning for ambiguous/high-value cases and final synthesis.
175-
- Prefer pull-on-demand context retrieval over prompt-stuffing large logs or API payloads.
172+
- For high-volume inputs, apply the [High-Volume Triage and Escalation Pattern](workflow-patterns.md#high-volume-triage-and-escalation-pattern): cheap triage first, `noop`/safe output for known/duplicate/stale/low-value cases, frontier reasoning reserved for ambiguous/high-value cases, and context pulled on demand.
176173
- Use deterministic `steps:` plus compact files under `/tmp/gh-aw/` when large data must be preprocessed.
177174

178-
See also: [workflow-patterns.md](workflow-patterns.md), [subagents.md](subagents.md), and [token-optimization.md](token-optimization.md).
175+
See also: [subagents.md](subagents.md) and [token-optimization.md](token-optimization.md).
179176

180177
### 9. Omit unnecessary defaults
181178

.github/aw/safe-outputs-runtime.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ description: Safe-output reference for runtime defaults, custom jobs, scripts, a
44

55
# Safe Outputs: Runtime and Extensibility
66

7-
8-
The report-incomplete safe-output is automatically enabled by default and is distinct from `noop`. Use it when required tools or data are unavailable and the task cannot be meaningfully performed (e.g., MCP server crash, missing authentication, inaccessible repository). When an agent emits `report_incomplete`, gh-aw activates failure handling even when the agent process exits 0 — preventing empty outputs from being classified as successful. This ensures every unrecoverable failure is tracked.
7+
The `report-incomplete` safe-output is enabled by default and is distinct from `noop`. Use it when required tools or data are unavailable and the task cannot be meaningfully performed (e.g., MCP server crash, missing authentication, inaccessible repository). When an agent emits `report_incomplete`, gh-aw activates failure handling even when the agent process exits 0 — preventing empty outputs from being classified as successful, so every unrecoverable failure is tracked.
98

109
- `jobs:` - Custom safe-output jobs registered as MCP tools for third-party integrations
1110

.github/aw/syntax-agentic.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ description: Agentic workflow specific frontmatter fields for GitHub Agentic Wor
1616
- Key names limited to 64 characters
1717
- Values limited to 1024 characters
1818
- Example: `metadata: { team: "platform", priority: "high" }`
19-
- **`github-token:`** - Default GitHub token for workflow (must use `${{ secrets.* }}` syntax)
19+
- **`github-token:`** - GitHub token override (must use `${{ secrets.* }}` syntax). Not a top-level field: set it under `on:` (trigger checks), `tools.github`, or `safe-outputs`.
2020
- **`on.roles:`** - Repository access roles that can trigger workflow (array or `"all"`). Default `[admin, maintainer, write]`; available roles: `admin`, `maintainer`, `write`, `read`, `all`.
21-
- **`bots:`** - Bot identifiers allowed to trigger workflow regardless of role permissions (array; e.g. `[dependabot[bot], renovate[bot], github-actions[bot]]`). The bot must be active (installed) on the repository to trigger.
21+
- **`on.bots:`** - Bot identifiers allowed to trigger workflow regardless of role permissions (array; e.g. `[dependabot[bot], renovate[bot], github-actions[bot]]`). The bot must be active (installed) on the repository to trigger.
2222
- **`strict:`** - Enable enhanced validation for production workflows (boolean, defaults to `true`; strongly recommended)
2323
- Prefer `strict: true`; `strict: false` is dangerous, should be extremely rare, and must be carefully security reviewed before use
2424
- **`max-turns:`** - AWF turn cap applied consistently across all agentic engines (integer or expression, e.g. `${{ inputs.max-turns }}`). The engine-level `engine.max-turns` is a deprecated alias kept for backward compatibility — prefer this top-level field. Not supported by the `gemini` engine.
@@ -81,6 +81,7 @@ description: Agentic workflow specific frontmatter fields for GitHub Agentic Wor
8181

8282
- Selected variant available as `${{ experiments.<name> }}` and in `{{#if experiments.<name> }}` template blocks
8383
- See [A/B Testing Experiments](experiments.md) for full design guidance
84+
- **`evals:`** - ⚠️ Experimental. BinEval binary (YES/NO) evaluation questions run after safe-outputs and before the conclusion job. Shorthand: a list of `{ id, question, model? }` objects. Extended form: object with `questions`, plus optional `model` (default alias/ID for all questions) and `runs-on`.
8485

8586
- **`imports:`** - Array of workflow specifications to import (array)
8687
- Format: `owner/repo/path@ref` or local paths like `shared/common.md`

.github/aw/update-agentic-workflow.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,7 @@ See [workflow-editing.md](workflow-editing.md) for the full frontmatter-vs-body
5858

5959
## Cost-Oriented Update Checks
6060

61-
When refining existing workflows, preserve minimal edits while verifying:
62-
63-
- cheap triage runs before escalation for high-volume inputs
64-
- known/duplicate/stale/low-value cases stop with explicit `noop` or safe output
65-
- expensive/frontier reasoning is limited to ambiguous or high-value cases and final synthesis
66-
- large raw logs/payloads are pulled on demand instead of pushed into initial prompts
67-
- sub-agent fan-out stays bounded and worker returns stay compact
68-
- changes are measured with `gh aw audit` (`aic`, input/output/cache token fields) and quality regressions are treated as failures
69-
70-
See also: [token-optimization.md](token-optimization.md), [subagents.md](subagents.md), and [workflow-patterns.md](workflow-patterns.md).
61+
When refining existing workflows, keep edits minimal and confirm the design still follows the [High-Volume Triage and Escalation Pattern](workflow-patterns.md#high-volume-triage-and-escalation-pattern): cheap triage before escalation, `noop`/safe output for known/duplicate/stale cases, frontier reasoning reserved for high-value cases, and context pulled on demand. Keep sub-agent fan-out bounded (see [subagents.md](subagents.md)), then measure the change with `gh aw audit` and treat token or quality regressions as failures (see [token-optimization.md](token-optimization.md)).
7162

7263
## Security Rules
7364

0 commit comments

Comments
 (0)