docs: add CHANGELOG.md with breaking change tracking#423
docs: add CHANGELOG.md with breaking change tracking#423
Conversation
Add a CHANGELOG.md following the release-toolkit format with historical entries back to v0.3.0. Each version is categorized into Breaking Changes, New Features, Bug Fixes, and Internal Changes. The release script now automatically manages the Trunk section during releases, and the developer workflow docs mention updating the changelog when merging user-facing changes.
|
With #392, I attempted to automate change groups and avoid the need to manually type change log entries, including breaking changes. If a PR is labeled appropriately, its title is included in the GitHub Release notes in the corresponding group. If a PR title follows Conventional Commits spec, a GitHub Action automatically labels the PR appropriately. I.e., the PR title becomes the release note. Curious your thoughts: Is there value in a |
Summary
CHANGELOG.mdfollowing the release-toolkit format with historical entries back to v0.3.0, categorized into Breaking Changes, New Features, Bug Fixes, and Internal Changesbin/release.shto automatically manage the Trunk section during releases (renames Trunk to the version number and creates a fresh empty Trunk section)docs/releases.mdanddocs/code/developer-workflows.mdto document the changelog workflowThe key motivation is surfacing breaking changes prominently so consumers of the library can plan upgrades. Retroactive breaking changes have been identified for v0.6.0, v0.8.0, v0.10.0, v0.12.0, and v0.15.0.
Test plan
make release VERSION_TYPE=patch DRY_RUN=true(dry run skips the sed, but confirms the function is wired in)update_changelog, and confirm the Trunk section is correctly replaced and recreated