ci: automate releases via release-please + PR title lint#59
Merged
Conversation
Replaces the manual "remember to run make release" flow with two GitHub Actions that together guarantee releases can't be forgotten or mislabeled: - release-please.yml watches main; whenever there are unreleased commits with conventional-commit prefixes, it opens (or updates) a "Release PR" with auto-computed version + auto-generated CHANGELOG. Merging that PR creates the v* tag, which publish.yml already consumes to ship to PyPI. The version bump is deterministic from semver rules on the commit prefixes (feat = minor, fix = patch, BREAKING CHANGE = major), so it can't be picked wrong. - lint-pr-title.yml runs amannn/action-semantic-pull-request against every PR title. Titles without a conventional prefix get a red check; combined with branch protection (enable later in repo settings → Branches), this blocks merging until the title is fixed. Important specifically because release-please reads PR titles under squash-merge, and a missing prefix would silently miss a release. The setuptools-scm migration from PR #56 was the prerequisite — with the version derived from tags rather than a source field, release-please doesn't need to edit any source files (uses release-type: simple). The manifest file tracks the current released version (0.3.5) so the bot's first run picks up from where we are. `make release` and friends stay as a manual escape hatch for the rare case where the release-please flow can't be used (e.g. urgent security fix that shouldn't wait for the normal Release PR cycle). AGENTS.md updated to describe the new flow. After merge: - The next PR with a `feat:` or `fix:` will trigger a Release PR - Enable branch protection on main → require lint-pr-title check - Stop running make release; let the bot do it
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
1 participant
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.
Summary
Replaces the manual "remember to run make release" flow with two GitHub Actions that together make releases impossible to forget or mislabel:
Why
This session alone surfaced the "remember to release" failure mode multiple times. After merging PR #54, PR #55, PR #56 we kept needing to manually decide whether and how to release. With release-please, you can't forget — there's a visible Release PR on the repo asking to be merged.
What's in this PR
Tradeoffs
After merge
Two follow-up steps for you to do manually (one-time):
Then the next PR you open with a `feat:` or `fix:` title will demonstrate the new flow end-to-end.
Test plan