doc: document tracker-id frontmatter field in main reference#34799
Merged
pelikhan merged 3 commits intoMay 26, 2026
Conversation
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Document tracker-id frontmatter field in main reference
doc: document May 25, 2026
tracker-id frontmatter field in main reference
Collaborator
|
@copilot unbloat changes |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the tracker-id: frontmatter field to the main frontmatter reference, where it was previously undocumented despite being used in 90 workflows.
Changes:
- New
### Tracker ID (tracker-id:)section in the main frontmatter reference, placed alongsidesource:andredirect:. - Documents purpose, generated hidden HTML marker, GitHub search usage, constraints (8–128 chars, alphanumeric/hyphen/underscore, trimmed), two examples, and a cross-reference to the Footers reference.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/frontmatter.md | Adds a new section documenting the tracker-id field, matching the schema constraints and existing runtime behavior. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Author
Done in 6d89b98. Removed the duplicate HTML code block, collapsed the bullet constraint list to a single prose sentence, dropped the verbose NOTE block, and cut the second YAML example. The section now matches the brevity of adjacent entries like |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
tracker-idis used by 90 workflows in this repo but had no coverage indocs/src/content/docs/reference/frontmatter.md— the primary discoverable reference for workflow authors.Changes
docs/src/content/docs/reference/frontmatter.md: adds### Tracker ID (tracker-id:)section placed alongside the other workflow-identity fields (source:,redirect:), covering:<!-- gh-aw-tracker-id: … -->in every asset (issues, PRs, discussions, comments) the workflow creates.github/workflows/Inserts into every created asset body:
<!-- gh-aw-tracker-id: code-simplifier -->Which can be searched with: