DOCUMENTATION EDITING / GitHub
GitHub Docs GHES release notes
Drafts GitHub Enterprise Server release notes from a releases issue or a changelog pull request.
“Generates release notes for GitHub Enterprise Server features from releases issues or changelog PRs.”
01 / THE REASONING
Why this made the selection.
- A private-preview title is skipped and returns an empty list, and the word deprecated is forbidden.
- Feature headings must come from the release-note template, and the product_name Liquid variable is explicitly said not to exist.
02 / THE REVIEW RECORD
What we actually inspected.
Source review has boundaries.
A clear record is more useful than a “safe” badge.
Material inspected
- .github/agents/ghes-release-notes.md
- LICENSE-CODE
- Round 2: pinned definition, output contract and permission/dependency boundaries reread on 2026-10-14
Our findings
- Frontmatter tools are read, search, web, and github/*, and the name is GHES-Release-Notes.
- A title containing Private Preview is skipped and the output is an empty array.
- The file says never to use the word deprecated, and to say closing down instead.
- It says the product_name Liquid variable does not exist and names prodname_dotcom and prodname_ghe_server instead.
- Private previews and features not shipping to GHES are skipped with source-attributed reasons instead of forced into a release.
- Documentation anchors must be verified; unverifiable anchors are dropped while valid page links remain.
Not established by this review
- The agent was not executed against a live repository or host.
The review applies to the material and revision named here. A newer upstream release can change its behavior.
03 / PUT IT TO WORK
Use the role in your project.
- Read the agent file at the reviewed commit. No install command is published.
- Do not treat a private-preview issue as a release note.
Before you start
- A checkout of github/docs at the reviewed commit
04 / FOLLOW THE EVIDENCE
The source trail.
Our notes are separate from the original resource.
Check upstream before adopting a new version.
https://github.com/github/docs/blob/b3ca4b7986534061037979e480c9d363fc95a909/.github/agents/ghes-release-notes.md
Supports: summary, whySelected, tool list
https://github.com/github/docs/blob/b3ca4b7986534061037979e480c9d363fc95a909/data/release-notes/PLACEHOLDER-TEMPLATE.yml
Supports: Feature headings, closing_down and retired sections
- MIT licence for code ↗Checked
https://github.com/github/docs/blob/b3ca4b7986534061037979e480c9d363fc95a909/LICENSE-CODE
Supports: Redistribution terms, Copyright 2026 GitHub