| name | release-readiness |
| description | Use when preparing a versioned release of gtex-link. Walks through changelog, version bump, tag, and watching the release workflow. |
Release readiness
Pre-flight
- Confirm
main is green: latest CI run succeeded.
- Verify there are no outstanding
dependabot PRs that should land first.
- Confirm
CHANGELOG.md has an Unreleased section with all user-visible changes since the last tag.
Bump
- Open
pyproject.toml and bump version. Follow semver:
MAJOR.MINOR.PATCH
- MAJOR for breaking changes
- MINOR for feature additions
- PATCH for fixes
- Rewrite the
[Unreleased] heading in CHANGELOG.md to [X.Y.Z] - YYYY-MM-DD and add a fresh empty [Unreleased] section above it.
- Commit:
chore(release): bump to X.Y.Z.
Tag and push
git tag vX.Y.Z
git push origin main vX.Y.Z
Watch
The release.yml workflow runs on v* tag pushes. It runs make ci-local, validates compose configs, and builds the release Docker image.
Roll forward
If release.yml fails, fix on main, bump to vX.Y.(Z+1), retag.