This project uses a CHANGELOG.md.
Each pull request should also update the "Unreleased" section of the changelog. It should also update the "Deployment Migration Notes" Section of the unreleased section as preparation for the release.
For each release there will be a separate section especially with an "Overview" section containing a summary from a product perspective.
Releases will especially contain a "Compatible Versions" section with the final docker images and versions of other software components that are connected by APIs.
The changelog uses Semantic Versioning. Changes are categorized as either Major, Minor or Patch Changes.
For this project, changes are categorized as the following:
Major changes include:
- UX / Product overhauls.
- Breaking changes to APIs with API contracts with other deployment units (our UI doesn't count).
Sometimes minor version releases can be upgraded to major releases on release if the release signifies a major milestone to the customer.
Minor changes include:
- New or changed features from a customer perspective.
- New APIs with API contracts with other deployment units (our UI doesn't count).
- New Product Documentation
Patch changes are basically everything else, that does not add, change or remove any product or external API features.
- Product Fixes, Bugfixes, Refactorings
- Changes to existing Product Documentation
- New or changes to existing Developer Documentation
- Everything else
On releases the "Unreleased" section is emptied in favor of a new section for the release.
Whether a release will bump the major, minor or patch version is decided by the unreleased changes in the changelog.
The Release sections will be cleaned up on release, improved with additional information and made useful for the customer and people deploying the application, containing both product changes and deployment migration notes.
More on that can be found in the Release Issue Template.