Skip to content

ci(release): add Releasaurus release automation - #1

Closed
adamsrnmsu wants to merge 1 commit into
sandialabs:mainfrom
adamsrnmsu:ci/releasaurus
Closed

adamsrnmsu wants to merge 1 commit into
sandialabs:mainfrom
adamsrnmsu:ci/releasaurus

Conversation

@adamsrnmsu

Copy link
Copy Markdown
Collaborator

What

Adds Releasaurus (releasaurus.toml + .github/workflows/release.yml). A push to main opens or updates a release PR (next version from conventional commits, plus changelog); merging it bumps pyproject.toml, tags vX.Y.Z and publishes the GitHub Release.

  • release_type = "python" bumps pyproject.toml. That is the only place the version lives: parseus.__version__ reads package metadata, and the Makefile and compose files read it from pyproject.toml. Nothing else to keep in sync.
  • Action pinned by full commit SHA (v1.3.0), top-level contents: read, write permissions only on the release job, concurrency group so runs never race. No PAT or App secret; only GITHUB_TOKEN.
  • Tags/releases created with GITHUB_TOKEN do not trigger other workflows, so verify-version and verify-release-compose in ci.yml would never fire for a Releasaurus release. A verify job in release.yml runs the same checks on the tag just created. ci.yml is unchanged and still covers hand-pushed v* 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.0 already exists on origin (it points at current main), so Releasaurus uses it as the baseline; nothing is "seeded".
  • No release PR appears until there are commits after v1.0.0. Existing history is not conventional, but none of it is after the tag. Commits are matched on the conventional prefix: feat gives minor, fix (and other types such as ci/chore) give patch, ! or BREAKING CHANGE: gives major; an unprefixed message falls in "Miscellaneous". Dry-run (releasaurus 1.3.0, local clone with this config plus one ci: commit) computed v1.0.1, touching pyproject.toml and CHANGELOG.md. So merging this PR itself will cause a v1.0.1 release PR to be opened on the next push; close it or hold it if you do not want a release yet.
  • Existing CHANGELOG.md: Releasaurus prepends the generated section above the file's existing # Changelog title 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

  • actionlint and zizmor clean on release.yml.
  • releasaurus release-pr --dry-run --local-path via the rgonnella/releasaurus Docker image: base v1.0.0, next v1.0.1, would update pyproject.toml and CHANGELOG.md.
  • The workflow itself can only be exercised on GitHub after merge.

🤖 Generated with Claude Code

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>
@adamsrnmsu

Copy link
Copy Markdown
Collaborator Author

Superseded by #3: branch renamed to the type-description convention and conventions aligned with sceptre-phenix-apps.

@adamsrnmsu adamsrnmsu closed this Nov 12, 2026
@adamsrnmsu
adamsrnmsu deleted the ci/releasaurus branch November 12, 2026 03:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant