All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
When a new release is proposed:
- Create a new branch
bump/x.x.x
(this isn't a long-lived branch!!!); - The Unreleased section on
CHANGELOG.md
gets a version number and date; - Open a Pull Request with the bump version changes targeting the
main
branch; - When the Pull Request is merged, a new
git
tag must be created using GitHub environment.
Releases to productive environments should run from a tagged version. Exceptions are acceptable depending on the circumstances (critical bug fixes that can be cherry-picked, etc.).