Conversation
There was a problem hiding this comment.
Pull request overview
Updates the documentation glossary with new definitions for recently introduced user-facing features around token fallback for Copilot assignment and label-trigger shorthand workflows.
Changes:
- Added a glossary entry for
GH_AW_AGENT_TOKENas a magic secret name used forassign-to-agenttoken fallback. - Added a glossary entry defining “Label Trigger Shorthand” and its expansion behavior (including
workflow_dispatch+inputs.item_number).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
|
||
| ### GH_AW_AGENT_TOKEN | ||
|
|
||
| A recognized "magic" repository secret name that GitHub Agentic Workflows automatically uses as a fallback Personal Access Token for `assign-to-agent` operations. When set, no explicit `github-token:` reference is needed in workflow frontmatter — the token is injected automatically. Required because GitHub App installation tokens are rejected by the Copilot assignment API. The token fallback chain is: `assign-to-agent.github-token` → `safe-outputs.github-token` → `GH_AW_AGENT_TOKEN` → `GH_AW_GITHUB_TOKEN` → `GITHUB_TOKEN`. See [Assign to Copilot](/gh-aw/reference/assign-to-copilot/). |
There was a problem hiding this comment.
The glossary entry says this is a fallback “Personal Access Token”, but assign-to-agent requires a fine-grained PAT (the page it links to explicitly states GITHUB_TOKEN is insufficient). Consider updating the wording to “fine-grained PAT” and clarifying that the fallback chain only works if the referenced secrets resolve to a suitable PAT.
| A recognized "magic" repository secret name that GitHub Agentic Workflows automatically uses as a fallback Personal Access Token for `assign-to-agent` operations. When set, no explicit `github-token:` reference is needed in workflow frontmatter — the token is injected automatically. Required because GitHub App installation tokens are rejected by the Copilot assignment API. The token fallback chain is: `assign-to-agent.github-token` → `safe-outputs.github-token` → `GH_AW_AGENT_TOKEN` → `GH_AW_GITHUB_TOKEN` → `GITHUB_TOKEN`. See [Assign to Copilot](/gh-aw/reference/assign-to-copilot/). | |
| A recognized "magic" repository secret name that GitHub Agentic Workflows automatically uses as a fallback fine-grained Personal Access Token (PAT) for `assign-to-agent` operations. When set, no explicit `github-token:` reference is needed in workflow frontmatter — the token is injected automatically. The value of `GH_AW_AGENT_TOKEN` (and any token resolved via the fallback chain) must be a fine-grained PAT with the scopes required by `assign-to-agent`; GitHub App installation tokens and the default `GITHUB_TOKEN` are rejected by the Copilot assignment API. The token fallback chain is a lookup order only and succeeds **only if** the resolved secret is a suitable fine-grained PAT: `assign-to-agent.github-token` → `safe-outputs.github-token` → `GH_AW_AGENT_TOKEN` → `GH_AW_GITHUB_TOKEN` → `GITHUB_TOKEN`. See [Assign to Copilot](/gh-aw/reference/assign-to-copilot/). |
|
|
||
| ### Label Trigger Shorthand | ||
|
|
||
| A compact syntax for label-based triggers: `on: issue labeled bug` or `on: pull_request labeled needs-review`. The compiler expands the shorthand to standard GitHub Actions trigger syntax and automatically includes a `workflow_dispatch` trigger with an `inputs.item_number` parameter, enabling manual dispatch for a specific issue or pull request. Supported for `issue`, `pull_request`, and `discussion` events. See [LabelOps patterns](/gh-aw/patterns/label-ops/). |
There was a problem hiding this comment.
“Supported for issue, pull_request, and discussion events” is a bit imprecise: the shorthand keyword issue expands to the GitHub Actions issues event (see pkg/workflow/label_trigger_parser.go where issue maps to issues). Consider adjusting the wording to avoid implying issue is an actual GitHub Actions event name.
| A compact syntax for label-based triggers: `on: issue labeled bug` or `on: pull_request labeled needs-review`. The compiler expands the shorthand to standard GitHub Actions trigger syntax and automatically includes a `workflow_dispatch` trigger with an `inputs.item_number` parameter, enabling manual dispatch for a specific issue or pull request. Supported for `issue`, `pull_request`, and `discussion` events. See [LabelOps patterns](/gh-aw/patterns/label-ops/). | |
| A compact syntax for label-based triggers: `on: issue labeled bug` or `on: pull_request labeled needs-review`. The compiler expands the shorthand to standard GitHub Actions trigger syntax and automatically includes a `workflow_dispatch` trigger with an `inputs.item_number` parameter, enabling manual dispatch for a specific issue or pull request. Supported for the GitHub Actions `issues` event (via the `issue` shorthand), as well as `pull_request` and `discussion` events. See [LabelOps patterns](/gh-aw/patterns/label-ops/). |
Glossary Updates - 2026-03-06
Scan Type
Terms Added
GH_AW_AGENT_TOKEN: New "magic" secret name recognized by GitHub Agentic Workflows for automatic PAT fallback in
assign-to-agentoperations. Added because PR Fix assign-to-agent failing with GitHub App tokens — auto-fallback to GH_AW_AGENT_TOKEN #19796 introduced explicit auto-fallback behavior and updated docs reference this secret prominently.Label Trigger Shorthand: Compact trigger syntax (
on: issue labeled bug) that the compiler expands to full GitHub Actions syntax. Added because PR Fix: wireinputs.item_numberfallback for label trigger shorthand workflows #19795 fixed a critical bug in howinputs.item_numberis wired for these shorthands, making it a user-facing feature worth defining.Terms Updated
None.
Changes Analyzed
Related Changes
inputs.item_numberfallback for label trigger shorthand workflows #19795 — Fix: wireinputs.item_numberfallback for label trigger shorthand workflows