Repository navigation
docs: keep the changelog header above new releases - #15
Merged
Merged
Conversation
Move the header to the top of CHANGELOG.md, with every release section under it, and drop the empty Unreleased section. Correct the 0.3.0 note: 0.3.0 was published to npm, after 0.4.0. Set changelogTitle in .releaserc.json to that header, so @semantic-release/changelog writes each new release below it instead of above it. src/__tests__/changelog.test.ts checks that the file starts with the configured title. Co-Authored-By: Claude <noreply@anthropic.com>
samc621
approved these changes
Oct 16, 2026
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
2 participants
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.
Moves the
# Changelogheader back to the top ofCHANGELOG.md, with every release section(0.4.5 down to 0.1.0) under it, and removes the empty
Unreleasedsection. Corrects the 0.3.0note: 0.3.0 was published to npm, after 0.4.0, rather than never.
@semantic-release/changelogwriteschangelogTitleat the top of the file, then the newrelease's notes, then the existing content with that title removed. With no
changelogTitleset,each release went above the header.
.releaserc.jsonnow setschangelogTitleto the header text,so the next release lands directly under it.
src/__tests__/changelog.test.tschecks thatCHANGELOG.mdstarts with the configuredchangelogTitle, has a single top-level heading, puts the newest release directly under theheader, and has no
Unreleasedsection.docs:commit, so it triggers no release.