Repository navigation
ci(release): add Releasaurus release automation - #1
Closed
adamsrnmsu wants to merge 1 commit into
Closed
adamsrnmsu wants to merge 1 commit into
adamsrnmsu wants to merge 1 commit into
Conversation
Why: parseus has no release automation; versions are bumped by hand and the tag-gated CI jobs depend on a manual tag push. What: releasaurus.toml (python release_type, bumps pyproject.toml, the single version source: __version__ reads package metadata, Makefile/compose read pyproject) and .github/workflows/release.yml (release then release-pr on push to main, SHA-pinned action, least-privilege permissions, concurrency group). Tags made with GITHUB_TOKEN do not trigger other workflows, so ci.yml verify-version and verify-release-compose would never run for a Releasaurus release; a `verify` job in the release workflow runs the same checks on the new tag. Verified: actionlint and zizmor clean; releasaurus 1.3.0 release-pr --dry-run against a local clone resolved base v1.0.0, next v1.0.1, targets pyproject.toml and CHANGELOG.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
6 of 11 tasks
Collaborator
Author
|
Superseded by #3: branch renamed to the type-description convention and conventions aligned with sceptre-phenix-apps. |
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.
What
Adds Releasaurus (
releasaurus.toml+.github/workflows/release.yml). A push tomainopens or updates a release PR (next version from conventional commits, plus changelog); merging it bumpspyproject.toml, tagsvX.Y.Zand publishes the GitHub Release.release_type = "python"bumpspyproject.toml. That is the only place the version lives:parseus.__version__reads package metadata, and the Makefile and compose files read it frompyproject.toml. Nothing else to keep in sync.contents: read, write permissions only on thereleasejob,concurrencygroup so runs never race. No PAT or App secret; onlyGITHUB_TOKEN.GITHUB_TOKENdo not trigger other workflows, soverify-versionandverify-release-composeinci.ymlwould never fire for a Releasaurus release. Averifyjob inrelease.ymlruns the same checks on the tag just created.ci.ymlis unchanged and still covers hand-pushedv*tags.Maintainer action required
Enable Settings > Actions > General > Workflow permissions > "Allow GitHub Actions to create and approve pull requests" (and keep workflow permissions able to be raised per job). Without it the release PR cannot be opened.
How the first release behaves
v1.0.0already exists on origin (it points at currentmain), so Releasaurus uses it as the baseline; nothing is "seeded".v1.0.0. Existing history is not conventional, but none of it is after the tag. Commits are matched on the conventional prefix:featgives minor,fix(and other types such asci/chore) give patch,!orBREAKING CHANGE:gives major; an unprefixed message falls in "Miscellaneous". Dry-run (releasaurus 1.3.0, local clone with this config plus oneci:commit) computedv1.0.1, touchingpyproject.tomlandCHANGELOG.md. So merging this PR itself will cause av1.0.1release PR to be opened on the next push; close it or hold it if you do not want a release yet.CHANGELOG.md: Releasaurus prepends the generated section above the file's existing# Changelogtitle and leaves the hand-written Keep-a-Changelog content and the empty[Unreleased]heading untouched. The mixed format is cosmetic; if you want Releasaurus to own the file, the handwritten part can be trimmed in a follow-up.Verification
actionlintandzizmorclean onrelease.yml.releasaurus release-pr --dry-run --local-pathvia thergonnella/releasaurusDocker image: basev1.0.0, nextv1.0.1, would updatepyproject.tomlandCHANGELOG.md.🤖 Generated with Claude Code