Repository navigation
docs(release): record that the repository allows only squash merges - #94
Merged
Merged
Conversation
Since 2026-10-24 the GitHub settings allow squash merges only, with the PR title as the commit title and a blank body. release-please splits any body paragraph that starts with a Conventional Commit type into a second changelog entry, so the merge commits behind 1.1.3 and 1.2.0 listed each change twice. RELEASING.md and the release rule now say so. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
With a blank squash body, Release-As and BREAKING CHANGE footers on branch commits never reach main. Say how to add them when merging. Co-Authored-By: Claude Opus 5.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
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.
The repository's merge settings changed on 2026-10-24: squash merges only (merge commits and rebase merges disabled), with the PR title as the commit title and a blank body, the GitHub option "Default to pull request title".
Why
release-please's
splitMessages(src/commit.ts) splits a commit message wherever a blank line is followed by a line starting withfeat|fix|docs|…(scope):, and turns each part into its own changelog entry. A GitHub merge commit's body is the PR title, so every merged PR produced two entries: one from the merge commit and one from the branch commit. That's why 1.1.3 and 1.2.0 list each change twice. With the PR title as the only text, each PR gives one entry. Earlier changelog entries stay as they are; the rules say not to hand-editCHANGELOG.md.What changed in the repo
docs/RELEASING.md(Cautions) and.claude/rules/release.mdnow record the setting and the reason.CLAUDE.md, the release-manager agent (gh pr merge <n> --squash) and the hook tests already assumed squash, so nothing else needed to change.Trade-offs of the blank body: a breaking change has to go in the title (
feat!:), because aBREAKING CHANGE:footer in the PR description no longer reachesmain. Changelog entries also lose the "closes #N" links that commit-body footers used to add.Closes #Nin a PR description still closes the issue on merge.Checks
🤖 Generated with Claude Code