Skip to content

Commit e439586

Browse files
Copilotgh-aw-botpelikhan
authored
doc: document tracker-id frontmatter field in main reference (#34799)
* Initial plan * doc: document tracker-id frontmatter field in main reference Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com> * doc: trim tracker-id section to remove bloat Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com> Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
1 parent 2528358 commit e439586

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,24 @@ The `redirect` field uses the same `owner/repo/path@ref` format as `source:`. Re
468468
> [!NOTE]
469469
> The `redirect` field is set by workflow *authors* to signal that a workflow has moved. It is not typically set by end-users. If you see a redirect when running `gh aw update`, it means the upstream workflow has been relocated.
470470

471+
### Tracker ID (`tracker-id:`)
472+
473+
Tags every asset (issues, pull requests, discussions, comments) the workflow creates with a hidden HTML comment — `<!-- gh-aw-tracker-id: … -->` — enabling GitHub search to find all items associated with this workflow.
474+
475+
```yaml wrap
476+
tracker-id: code-simplifier
477+
```
478+
479+
Accepts 8–128 alphanumeric characters, hyphens, and underscores. Most workflows use their filename as the tracker ID.
480+
481+
Search for all assets created by a specific workflow:
482+
483+
```
484+
repo:owner/repo "gh-aw-tracker-id: code-simplifier" in:body
485+
```
486+
487+
See [Footers](/gh-aw/reference/footers/) for marker details and footer visibility control.
488+
471489
### Private Workflows (`private:`)
472490

473491
Mark a workflow as private to prevent it from being installed into other repositories via `gh aw add`.

0 commit comments

Comments
 (0)