Repository navigation
ci: let release-please maintain CHANGELOG.md - #78
Merged
Merged
Conversation
Release notes lived only on GitHub Releases, so nobody reading the package or the repo could see what changed between versions. release-please now writes CHANGELOG.md on every release PR. A new "Behaviour Changes" section, listed first, takes behaviour(scope) lines from a PR body's override block. CHANGELOG.md is seeded with the releases the release-please flow made, 1.5.4 to 1.12.0, in the format release-please writes, so the next release inserts its entry above them.
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 users 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.extra-files(src/core/config.ts) and.release-please-manifest.json(1.12.0) are unchanged.CHANGELOG.mdis new, seeded with the eleven releases the release-please flow made so far (1.5.4 to 1.12.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.package.json:CHANGELOG.mdjoins thefileslist, so the npm package ships it.docs/contributing.md(Releases) says that the release PR now updatesCHANGELOG.md, and shows how to flag a behaviour change with release-please's commit-override block in the PR body.How to flag a behaviour change
docs/contributing.mdshows the block. In short: before merging, end the PR body with release-please's commit-override block, holding onefeatorfixline and onebehaviourline. Each line becomes one changelog entry.A
behaviourline does not bump the version on its own next to afeatorfix: that line sets the version. Alone, without afeatorfix, it still opens a patch release, because it is a visible section.This body describes the block in words on purpose. release-please reads the first commit-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
changelog-sections. Only the dates were set by hand, to each release's date (UTC).# Changelog, and the seeded entries and the last line stayed unchanged below it. A samplefeatplusbehaviouroverride rendered "Behaviour Changes" above "Features", and released 1.13.0.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.npm run typecheckandnpm testare not affected: no code changes.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.