Skip to content

Commit c3eb76c

Browse files
authored
docs: add frontmatter skills reference with token auth examples (#42747)
1 parent 1e8eec2 commit c3eb76c

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

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

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,46 @@ tools:
176176

177177
See [Tools](/gh-aw/reference/tools/) for complete documentation on built-in tools, GitHub toolsets, and MCP server configuration.
178178

179+
### Frontmatter Skills (`skills:`)
180+
181+
Installs external Copilot skills in the activation job before the agent runs.
182+
Each entry must be pinned to a 40-character lowercase commit SHA.
183+
184+
Supported entry formats:
185+
186+
- String form (shared authentication):
187+
- `owner/repo@<40-char-sha>`
188+
- `owner/repo/skill/path@<40-char-sha>`
189+
- Object form (per-skill authentication):
190+
- `skill` (required)
191+
- `github-token` (optional)
192+
- `github-app` (optional)
193+
194+
`github-token` and `github-app` are mutually exclusive for each object entry.
195+
`github-token` must be an expression such as `${{ secrets.NAME }}` or
196+
`${{ needs.auth.outputs.token }}`.
197+
198+
```yaml wrap
199+
skills:
200+
# Shared auth via workflow-level activation token
201+
- mattpocock/skills/tdd@801dca688564c529fa84f247f64472520d9ebe28
202+
203+
# Per-skill PAT (or fallback) for private skill repositories
204+
- skill: mattpocock/skills/diagnosing-bugs@801dca688564c529fa84f247f64472520d9ebe28
205+
github-token: ${{ secrets.MATT_SKILLS_PAT || secrets.GITHUB_TOKEN }}
206+
207+
# Per-skill GitHub App credentials
208+
- skill: mattpocock/skills/domain-modeling@801dca688564c529fa84f247f64472520d9ebe28
209+
github-app:
210+
client-id: ${{ vars.MATT_SKILLS_APP_CLIENT_ID }}
211+
private-key: ${{ secrets.MATT_SKILLS_APP_PRIVATE_KEY }}
212+
```
213+
214+
See [Glossary: Frontmatter Skills](/gh-aw/reference/glossary/#frontmatter-skills-skills)
215+
for terminology, and
216+
[`mattpocock-skills-reviewer.md`](https://github.com/github/gh-aw/blob/main/.github/workflows/mattpocock-skills-reviewer.md)
217+
for a full workflow example using `skills:`.
218+
179219
### MCP Scripts (`mcp-scripts:`)
180220

181221
Enables defining custom MCP tools inline using JavaScript or shell scripts. See [MCP Scripts](/gh-aw/reference/mcp-scripts/) for complete documentation on creating custom tools with controlled secret access.

0 commit comments

Comments
 (0)