Versioning: SemVer, tags, and changelogs
On this page
Operational Versioning Rules
- Use a consistent version scheme (often SemVer) for releases.
- Tag releases immutably and link tags to artifacts/digests.
- Changelog must map user-visible changes and risk level.
Tagging and Changelog (Example)
# create annotated tag git tag -a v1.8.0 -m "release v1.8.0" git push origin v1.8.0 # generate changelog snippet (example idea) git log v1.7.0..v1.8.0 --oneline --no-decorate
Release Checklist
- Artifact digest recorded and signed
- DB migrations reviewed and reversible
- Rollback plan validated
- Monitoring dashboard prepared
Failure Modes
- No tags → hard to map incident to code.
- Version drift between services → confusion during rollback.