docs: add CHANGELOG.md with breaking change tracking#423
Draft
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.
github-actions
bot
added
the
[Type] Developer Documentation
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
1 participant
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.
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