docs: add note about templatable fields in safe outputs#17740
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR adds documentation about templatable fields in safe outputs, explaining that certain configuration fields can accept GitHub Actions expressions (e.g., ${{ inputs.foo }}) in addition to literal values. This enables dynamic runtime configuration through workflow inputs and other GitHub Actions context values.
Changes:
- Added a new "Templatable Fields" section to the safe-outputs.md documentation explaining templatable booleans and integers
- Included examples showing both literal values and GitHub Actions expressions
- Documented runtime error semantics for invalid values
- Added an unrelated entry to the agent-factory-status table
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/content/docs/reference/safe-outputs.md | Added comprehensive documentation for templatable fields, including boolean and integer field types with clear examples and error handling semantics |
| docs/src/content/docs/agent-factory-status.mdx | Added "Weekly Editors Health Check" workflow entry to the status table (appears unrelated to PR purpose) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | [Typist - Go Type Analysis](https://github.com/github/gh-aw/blob/main/.github/workflows/typist.md) | claude | [](https://github.com/github/gh-aw/actions/workflows/typist.lock.yml) | `0 11 * * 1-5` | - | | ||
| | [Ubuntu Actions Image Analyzer](https://github.com/github/gh-aw/blob/main/.github/workflows/ubuntu-image-analyzer.md) | copilot | [](https://github.com/github/gh-aw/actions/workflows/ubuntu-image-analyzer.lock.yml) | - | - | | ||
| | [Video Analysis Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/video-analyzer.md) | copilot | [](https://github.com/github/gh-aw/actions/workflows/video-analyzer.lock.yml) | - | - | | ||
| | [Weekly Editors Health Check](https://github.com/github/gh-aw/blob/main/.github/workflows/weekly-editors-health-check.md) | copilot | [](https://github.com/github/gh-aw/actions/workflows/weekly-editors-health-check.lock.yml) | - | - | |
There was a problem hiding this comment.
This change appears to be unrelated to the PR's stated purpose of adding documentation about templatable fields in safe outputs. The addition of the "Weekly Editors Health Check" workflow to the status table seems like an auto-generated update that was included inadvertently. Consider whether this should be in a separate PR or if the PR description should be updated to mention this workflow addition.
The
safe-outputs.mduser guide had no explanation of templatable fields, leaving users unaware they could supply GitHub Actions expressions (e.g.,${{ inputs.foo }}) in place of literal values for certain config fields.Adds a Templatable Fields section under
## Global Configuration Optionscovering:footer,group,close-older-issues,hide-older-comments,close-older-discussions,draft,allow-empty,auto-merge,report-as-issue,unassign-firstmaxon all safe output typesfalse; non-integer → operation fails)${{ ... }}expressionsWarning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
telemetry.astro.build/opt/hostedtoolcache/node/24.13.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.