chore(changelog): drop hand-written [Unreleased] section#38
Merged
Conversation
release-please generates each version's notes from Conventional Commits and prepends them to this file, so a hand-maintained [Unreleased] section duplicates the released content and confuses the changelog. Remove it; the prior entries are captured in the generated 0.1.0 section (and remain in git history). Signed-off-by: Sam Gammon <sam@elide.dev>
There was a problem hiding this comment.
Pull request overview
Removes the hand-written ## [Unreleased] section from CHANGELOG.md so that release-please can generate and prepend release notes without duplicating content in the changelog.
Changes:
- Delete the manually maintained
## [Unreleased]section (including its footer link reference) fromCHANGELOG.md. - Leave only the changelog header/preamble for release-please to append/prepend generated version entries.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Companion to #35 (release-as). release-please generates each version's changelog from Conventional Commits and prepends it to
CHANGELOG.md, so the hand-written## [Unreleased]section duplicates the released content — exactly what Copilot flagged on the release PR.Removing it so that when release-please regenerates the release PR off
main, the changelog is clean (preamble + the generated## 0.1.0section, no duplication). The prior curated entries are captured in the generated 0.1.0 notes and remain in git history.Merge this before the release PR. On merge, release-please regenerates the
0.1.0release PR with a clean changelog.