Documentation
Changelog
Track release changes and migration notes.
Overview
Review changelog entries before bumping versions in production services.
Example
Go
## v0.2.2
- Changed module path from github.com/meshackkazimoto/elgon to github.com/dmesha3/elgon
- Requires updating all imports to the new module path
## v0.1.0
- Added OpenAPI generator
- Added SQL queue backendBest Practices
- Read breaking change sections first.
- Roll out upgrades with canary deployments.
Common Pitfalls
- Skipping migration notes in minor releases.
- Upgrading dependencies without test coverage.