release.sh: use merge-commit for release PRs to preserve release notes#687
Merged
Conversation
The PR-based flow recommended rebase-merge, which rewrites the feature-PR commits to new SHAs on main. That breaks GitHub's auto-generated release notes (only the release author is credited, no PR list) and diverges main from dev. Switch the guidance to 'Create a merge commit' so main retains the original commits and the release notes generate correctly.
marionbarker
left a comment
marionbarker
left a comment
Collaborator
There was a problem hiding this comment.
Approve from code review.
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.
Background
The previous (non-PR) release flow merged
devintomainwith a fast-forwardgit merge, somaincontained the actual feature-PR commits. GitHub's auto-generated release notes walked those commits and produced a full, correctly-attributed changelog.Moving the release flow to PRs (#649) switched to rebase-merge, which rewrites those commits to new SHAs on
main. As a result, for v6.2.0:mainanddevended up on divergent histories (identical content, different SHAs).Change
Updates the guidance in both release PR bodies generated by
release.shfrom "use rebase-merge … same commit SHA" to "Create a merge commit". Merging (instead of rebasing) keeps the original feature-PR commits onmain, which:mainwithdev's lineage on the next release (the merge commit pullsdev's history back intomain).The same-SHA promise is dropped — it was a leftover from the old fast-forward flow and is not achievable through GitHub's PR merge buttons, none of which fast-forward.