Skip to content

Commit 3ce9975

Browse files
authored
Document threat-detection-suppress and max-runs deprecation; fix stale check-for-updates link (#53990)
1 parent 4bb738f commit 3ce9975

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

docs/src/content/docs/reference/frontmatter.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,19 @@ safe-outputs:
306306

307307
When omitted, `report-failed-jobs` defaults to `true`.
308308

309+
### Threat Detection Suppression (`threat-detection-suppress:`)
310+
311+
Suppresses specific threat-detection diagnostic rules (`CTR-###` identifiers) that would otherwise block safe-output processing, with a required, auditable justification. Each entry must include a `rule` matching `CTR-###`, a non-empty `reason`, and an optional `expires` date in `YYYY-MM-DD` format; once `expires` has passed (UTC), the suppression is no longer active and the rule is enforced again.
312+
313+
```yaml wrap
314+
threat-detection-suppress:
315+
- rule: CTR-012
316+
reason: "False positive on generated changelog entries; tracked in issue #123"
317+
expires: "2026-12-31"
318+
```
319+
320+
Compilation fails if any entry has an invalid `rule`, an empty `reason`, or a malformed `expires` date. See [Threat Detection](/gh-aw/reference/threat-detection/) for the full list of detection rules.
321+
309322
### Run Configuration (`run-name:`, `runs-on:`, `runs-on-slim:`, `timeout-minutes:`)
310323

311324
Standard GitHub Actions properties:
@@ -351,6 +364,16 @@ Environment variables can be defined at multiple scopes (workflow, job, step, en
351364
>
352365
> Use engine-specific secret configuration instead of the `env:` section to pass secrets securely.
353366

367+
### Turn Limit (`max-turns:`)
368+
369+
Caps the number of chat iterations (model responses and tool calls) the AWF proxy allows for a single workflow run, across all supported engines. Defaults to `500` when omitted. Accepts an integer or a GitHub Actions expression that resolves to an integer at runtime.
370+
371+
```yaml wrap
372+
max-turns: 20
373+
```
374+
375+
The top-level `max-runs:` field is a **deprecated** alias for `max-turns:` and is only accepted as a fallback for backward compatibility. Migrate existing workflows with `gh aw fix`. See [Cost Management](/gh-aw/reference/cost-management/#cap-turns-per-run) for more details.
376+
354377
### AI Credits Guardrail (`max-ai-credits:`)
355378

356379
Sets the AWF AI Credits budget used for cost enforcement. It is enabled by default and defaults to `1000` (`1k`) when omitted. Steering (budget-warning messages at 80%, 90%, 95%, and 99% of the budget) is enabled by default. Use plain integers or `K`/`M` suffixes such as `100000K` or `100M`. Set to a negative value to disable both budget enforcement and steering.

pkg/workflow/strict_mode_update_check_validation.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// - In strict mode: setting check-for-updates: false raises a compilation error.
99
// - In non-strict mode: setting check-for-updates: false emits a warning.
1010
//
11-
// See: https://github.github.com/gh-aw/reference/check-for-updates/
11+
// See: https://github.github.com/gh-aw/reference/frontmatter/#check-for-updates
1212
package workflow
1313

1414
import (

0 commit comments

Comments
 (0)