CHANGELOG.md is generated by release-please as part of each Release PR.
How It Works
- release-please runs on push to
main - It generates notes from conventional commits since the last release
- The notes are prepended to
CHANGELOG.mdin the open Release PR - Merging the Release PR commits the changelog and publishes the same notes as the GitHub Release
Changelog Sections
Commit types map to changelog sections:
| Commit Type | Changelog Section |
|---|---|
feat |
Features |
fix |
Bug Fixes |
perf |
Performance Improvements |
revert |
Reverts |
feat! / BREAKING CHANGE |
⚠ BREAKING CHANGES |
Types chore, docs, refactor, test, ci, build and style do not appear in the changelog.
Viewing Changelog
# View the changelog file
cat CHANGELOG.md
# View a specific GitHub release's notes
gh release view v5.31.0
# Preview the next entry in the open Release PR
gh pr list --label "autorelease: pending"
Missing Changelog Entry?
- Check the commit type: only
feat,fix,perfandrevertgenerate entries - Verify the commit landed on
main - Check the Release PR has been updated:
gh run list --workflow=release.yml - Ensure the commit message follows the conventional format
File Location
- Changelog:
CHANGELOG.md(root of repository) - Config:
release-please-config.json
Related
- See
release-managementskill for release workflow