Configure GitHub Release Notes Categories
Configure generated release-note categories and exclusions in the repository release configuration. Generated notes summarize merged pull requests; editorial review still determines whether the release explanation is useful and complete.
Step-by-step guide
Check access and scope
You need write access and maintained pull-request labels. Review the current configuration format in GitHub documentation before committing changes.
Audit pull-request labels
Review labels on representative merged pull requests.
Configure release YAML
Create .github/release.yml with the following minimal configuration. Replace bug, enhancement and ignore-for-release with your actual pull-request labels; an excluded label removes the pull request from generated notes.
changelog:
exclude:
labels:
- ignore-for-release
categories:
- title: Fixes
labels:
- bug
- title: Improvements
labels:
- enhancement
- title: Other changes
labels:
- "*"- Worked example: Group fixes and improvements separately, and exclude internal maintenance only when that omission will not hide a user-visible change. Explain migration requirements outside the generated pull-request list.
Include uncategorized changes
Keep the quoted "*" catch-all last so pull requests that match no earlier category appear under Other changes. Review that category for missing labels and user-visible changes.
Generate draft notes
Open Releases > Draft a new release, choose the intended tag and explicitly select the Previous tag. Click Generate release notes and save the draft while reviewing categories and omissions.
Review omissions and context
Review omitted work and add reader-facing context manually.
Verify the result
The draft notes include all intended changes and no unsupported promise of automatic completeness.
Common mistakes
Check the handoff edge case
A missing catch-all category can leave unexpected changes unexamined. Inspect uncategorized work during release preparation.
Sources and verification
Based on product documentation checked on 2026-10-24. This is a documentation-based guide, not a hands-on benchmark. Features and availability can change.