Skip to content

ci(release): adopt releasaurus with CalVer and the phenix-apps contribution workflow - #3

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

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

Conversation

@adamsrnmsu

Copy link
Copy Markdown
Collaborator

Description

Aligns Parseus with the release and contribution conventions of sandialabs/sceptre-phenix-apps. This supersedes #1 (branch renamed to the type-description convention).

  • Releases use releasaurus with CalVer (version_type = "%Y.%m.%d", tags like v2026.11.02) and PR links in the changelog. release_type = "python" is kept: a dry run confirmed it bumps [project].version in pyproject.toml to a date version.
  • release.yml follows the apps layout (push to main plus a workflow_dispatch dry-run input, fork guard, pinned action SHA, concurrency group, named steps, DRY_RUN on both commands). The Parseus-specific part stays: tags created with GITHUB_TOKEN do not trigger ci.yml, so one step records the new tag and a verify job runs the verify-version and verify-release-compose checks on it (skipped on dry runs).
  • CHANGELOG.md is now generated and not hand-edited. The Keep a Changelog preamble and the empty [Unreleased] heading are dropped; 1.0.0 keeps its content under a releasaurus-style heading.
  • Contribution workflow added: commits.yml (Conventional Commit subjects), codespell.yml + .codespellrc, a PR template, issue templates (bug form fitted to Parseus: host OS, Docker/Compose version, browser, Parseus version, install method), and .github/CONTRIBUTING.md (GPLv3, type-description branches, rebase-merge, generated changelog).
  • ~25 real typos found by codespell fixed (comments and docstrings only); ot and four precise words (thur, earch, tabel, unparseable) are ignored.
  • docs/DEVELOPMENT.md and docs/MANAGEMENT.md now describe CalVer/releasaurus releases instead of manual SemVer tagging.

Related Issues/PRs

Type of Change

  • Bugfix (fix)
  • Feature (feat)
  • Documentation (docs)
  • Refactor (refactor)
  • Chore (CI, build, dependencies, etc.) (chore)
  • Other (please describe):

Checklist

  • This PR conforms to the process detailed in the Contributing Guide (added in this PR).
  • I have included no proprietary/sensitive information in my code or the PR.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • I have tested my code (describe below).

Testing

  • actionlint (rhysd/actionlint) clean on the new/changed workflows (it reports one pre-existing shellcheck note in ci.yml, untouched); zizmor --offline clean on release.yml, commits.yml, codespell.yml.
  • codespell (2.4.3, same as the pinned action) passes on the repo.
  • releasaurus release-pr --dry-run --local-path (rgonnella/releasaurus image, local clone plus one feat: commit): release_type = "python" accepts CalVer; next version computed as 2026.11.12 (the UTC date of the run), updating pyproject.toml and CHANGELOG.md.
  • PEP 440 check: in a scratch worktree with version = "2026.11.02", parseus.__version__ reads 2026.11.2 (pip normalizes package metadata), but nothing depends on it matching: tests/test_version.py and tests/test_manage_parseus_lib.py pass (113 pass; test_build_paths_uses_var_lib_for_manifest_state fails on macOS because /var resolves to /private/var, and fails the same way without the version change). The verify-version shell snippet passes for tag v2026.11.02; the verify-release-compose snippet passes with compose rendering parseus:2026.11.02 in both compose files; the upgrade downgrade guard parses 02 as 2, so 2026.11.02 vs 2026.11.10 compare correctly. The tag, image tags, bundle name and install manifest all use the raw pyproject.toml string.
  • The workflows themselves can only run on GitHub after merge.

Additional Notes

  • Maintainer action: enable Settings > Actions > General > Workflow permissions > "Allow GitHub Actions to create and approve pull requests", otherwise the release PR cannot be opened.
  • First CalVer release: v1.0.0 already exists on main. No release PR appears until there are commits after it; this PR is one (a ci commit), so the next push to main opens a release PR for the date of that push, e.g. v2026.11.12, which is a plain jump from 1.0.0 to a date version (CalVer sorts above 1.0.0). Hold or close that release PR if you do not want a release yet. The changelog heading is a plain tag link for 1.0.0 since there is no earlier release to compare.
  • Following apps, .github/CODEOWNERS is not included. Maintainers may want one, and then a CODEOWNERS step and checklist line in the contributing guide and PR template.
  • The commits.yml check requires Conventional Commit subjects on every PR commit.

🤖 Generated with Claude Code

…bution workflow

Align Parseus with the release and contribution conventions of
sandialabs/sceptre-phenix-apps.

Release: releasaurus.toml uses CalVer (version_type %Y.%m.%d), links each
changelog entry to its PR, and keeps the python release type so the version
in pyproject.toml is bumped directly. release.yml follows the apps layout
(push to main plus a dry-run workflow_dispatch, fork guard, pinned action).
Tags made with GITHUB_TOKEN do not trigger ci.yml, so the job that records
the new tag and a verify job running the verify-version and
verify-release-compose checks on it are kept (skipped on dry runs).

CHANGELOG.md is now generated: the Keep a Changelog preamble and the empty
[Unreleased] heading are dropped and 1.0.0 keeps its content under a
releasaurus-style heading.

Contribution workflow: add commits.yml (Conventional Commit subject check),
codespell.yml and .codespellrc, a PR template, issue templates (bug form
fitted to Parseus), and CONTRIBUTING.md (type-description branch names,
rebase-merged PRs, generated changelog, GPLv3). Fix the typos codespell found.
docs/DEVELOPMENT.md and docs/MANAGEMENT.md now describe CalVer releases.

PEP 440 normalizes 2026.11.02 to 2026.11.2 in package metadata
(parseus.__version__) only; the tag check, compose image tags, bundle name,
manifest and upgrade comparison all read the raw pyproject string and were
verified with a leading-zero date version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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