Repository navigation
build: release with release-please - #30
Merged
Merged
Conversation
Every merge into main updates one release PR that bumps the version and writes the CHANGELOG from the squashed PR titles; merging it creates the tag, the GitHub Release and, where there is one, the image. Runs as github-actions[bot]; CI on the release PR is dispatched, since a GITHUB_TOKEN push starts no workflow.
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.
Problem
Releases are cut by hand: a
release/x.y.zbranch that bumps the version and moves theUnreleasedCHANGELOG entries, a squash merge, then a tag pushed from a laptop. Every step is a chance to forget something (the lockfile, a link ref, tagging the squashed commit).Change
release-please now cuts releases, as
github-actions[bot]withGITHUB_TOKEN(no App, no PAT):release-please-config.jsonand.release-please-manifest.json, seeded with the current version and today's release commit asbootstrap-sha. Tags keep thevprefix, the release title is the tag, release PRs are titledchore: release vX.Y.Z, and breaking changes stay MINOR while pre-1.0.featunder Added,fixunder Fixed,perfunder Changed,revertunder Reverted.refactor,docs,test,build,ci,choreandstyleare hidden and release nothing on their own..github/workflows/release.yml, on push tomain: runs release-please, then dispatches CI on the release branch, because a push made withGITHUB_TOKENstarts no workflow and the release PR needs its required checks. CI gains aworkflow_dispatchtrigger for that.releasejob leave CI. Where there is an image, publishing moves to a job ofrelease.ymlthat runs when a release is created.check-changelog.sh, thechangelog-rewritelabel triggers) and the emptyUnreleasedsection go away.docs/releasing.md, CONTRIBUTING, CLAUDE.md, the README docs table and the PR template describe the new process.Compatibility
No change for users. Contributors: a PR's title is now its CHANGELOG line and decides the next version.
Requires "Allow GitHub Actions to create and approve pull requests" in the repository's Actions settings.