docs: migrate changelog history to the changesets format - #346
Merged
Merged
Conversation
Pull request #132 (the Changesets release action) inserts new entries as a `## <version>` heading with `Major Changes`, `Minor Changes`, and `Patch Changes` sections. The existing history used a different heading level per release type (`#` for major, `##` for minor, `###` for patch) and labeled its sections `Features`, `Bug Fixes`, and `BREAKING CHANGES`, so once that pull request lands its heading would sit at the same level as the old sections' subheadings instead of above them. Rewrite every past release to use the same `##` heading and the same three section names, mapping `BREAKING CHANGES` notes to `Major Changes`, `Features` to `Minor Changes`, and `Bug Fixes` to `Patch Changes`. Where a breaking-change note duplicated a feature's description, keep a single entry under `Major Changes` instead of listing it twice. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
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.
Pull request #132 is the Changesets release action's "Version Packages" pull request. It inserts new release notes as a
## <version>heading followed byMajor Changes,Minor Changes, andPatch Changessections, right after the changelog's introductory paragraph.The existing history predates Changesets and used a different convention: the heading level varied with release type (
#for a major release,##for minor,###for patch), and each release grouped its entries underFeatures,Bug Fixes, andBREAKING CHANGES. Once pull request #132 lands, its## <version>heading would sit at the same level as the old releases'###section headings, so the file's structure would no longer nest correctly.This rewrites every past release to use the same heading level and section names Changesets produces:
BREAKING CHANGESnotes becomeMajor Changes,FeaturesbecomeMinor Changes, andBug FixesbecomePatch Changes. A few older releases had a breaking-change note that just restated a feature's description; those are now a singleMajor Changesentry instead of two.No content was removed, only reorganized and relabeled; compare links, dates, commit hashes, and issue references are all preserved.