Repository navigation
ci: let release-please maintain CHANGELOG.md - #65
Merged
Merged
Conversation
Turn skip-changelog off, so each release PR also writes its notes to CHANGELOG.md, and add a "Behaviour Changes" section, listed first, for the custom commit type behaviour. A merged PR states a behaviour change through a commit override block in its body. Seed CHANGELOG.md with the four releases made by release-please (2.4.0 to 2.6.0), in release-please's own format, so the next release PR inserts its entry above them. A last line points to GitHub Releases for older versions. The README's Releases section says how to flag a behaviour change.
carlosmayer
approved these changes
Nov 6, 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
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.
release-please now writes a
CHANGELOG.mdentry with every release, and a change in behaviour that callers must know about gets its own section at the top of that entry.This PR releases nothing.
ciis a hidden type, so release-please opens no release PR for it. The next release PR, for the nextfeatorfix, is the first one that writes toCHANGELOG.md.What changes
release-please-config.json:skip-changelogis nowfalse, and a new sectionbehaviour("Behaviour Changes") is listed first inchangelog-sections. Nothing else in the config changes..release-please-manifest.json(2.6.0) is unchanged.CHANGELOG.mdis new, seeded with the four releases release-please made so far (2.4.0 to 2.6.0). Each entry is what release-please writes for that release, in its own format: thefeatandfixcommits, with their PR and commit links and the release date. One line at the end points to GitHub Releases for older versions.CHANGELOG.md, and how to flag a behaviour change with a commit override block in the PR body.CHANGELOG.md: the package uses.npmignore, not afileslist, andnpm pack --dry-runlists it.How to flag a behaviour change
The README's Releases section shows the block. In short: before merging, end the PR body with a commit override block that holds one
featorfixline and onebehaviourline. Each line becomes one changelog entry.A
behaviourline never asks for a minor or major release. Thefeatorfixline next to it sets the version. On its own, without afeatorfix, it would still open a patch release, because it is a visible section.This body describes the block in words on purpose. release-please reads the first override block it finds in a merged PR's body, even inside a code fence, so an example block here would rewrite this PR's own changelog entry.
How it was checked
$schemaURL and the one shipped in release-please 17.11.2. The manifest is valid against its schema too.changelog-sections. Only the dates were set by hand, to each release's date.^17.3.0), its changelog updater added a sample 2.7.0 entry with onefeatand onebehaviourline to the seeded file. The entry landed right under# Changelog, with "Behaviour Changes" above "Features", and the seeded entries and the last line stayed in place below it.release-please release-pr --dry-runagainstmainfound no unreleased commits and would open no PR. It reads the config from the remote branch, so it does not exercise this branch's config.pnpm checkpasses.Out of scope
CHANGELOG.mdand in the release PR, not on the GitHub release page.featandfixchanges, as release-please does. Theci,docsandtestchanges in those releases stay on their GitHub release pages..github/and the release-please files, because.npmignoredoes not exclude them. This PR does not change that.