Release Checklist
Maintainer guide for predictable Nimbus releases. Use this as the canonical checklist before publishing framework updates.
Pre-release (planning)
- Decide version type: patch, minor, or major (SemVer).
- Review merged changes for breaking API/behavior impacts.
- Confirm migration, queue, and security changes have docs updates.
- Prepare release notes outline (features, fixes, breaking changes, upgrade notes).
Pre-release (quality gates)
# Required checks
go test ./...
go test -race ./...
go vet ./...- Ensure CI workflow is green on the target release commit.
- Smoke-test starter app locally (
nimbus-starter). - Verify docs pages render and search index includes new docs.
Release execution
- Create release branch or use protected main workflow.
- Update version constant(s) and changelog/release notes.
- Tag release commit (
vX.Y.Z). - Publish GitHub release with upgrade notes.
- Validate install path for new version in a clean sample app.
Post-release validation
- Create a fresh app using the released version and run boot smoke tests.
- Run queue worker, migrations, and health endpoint checks in staging.
- Monitor issue tracker for regressions during first 24-48 hours.
- Patch quickly if critical issues are reported.
Release template (copy/paste)
## Release vX.Y.Z
### Highlights
- ...
### Fixes
- ...
### Breaking changes
- ...
### Upgrade guide
1. ...
2. ...
### Verification
- [ ] go test ./...
- [ ] go test -race ./...
- [ ] go vet ./...
- [ ] starter app smoke test