-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from qonto/add-release
Document the release process
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Release Process | ||
|
||
## Overview | ||
|
||
The Database Monitoring Framework project has the following components: | ||
|
||
- prometheus-rds-alerts chart | ||
- prometheus-postgresql-alerts chart | ||
|
||
## Versioning Strategy | ||
|
||
The project is using [Semantic Versioning](https://semver.org): | ||
|
||
- MAJOR version may introduce incompatible changes | ||
- MINOR version introduces functionality in a backward compatible manner | ||
- PATCH version introduces backward compatible bug fixes | ||
|
||
## Releasing a New Version | ||
|
||
The following steps must be done by one of the Database Monitoring Framework Maintainers: | ||
|
||
- Verify the CI tests pass before continuing. | ||
- Create a tag using the current `HEAD` of the `main` branch by using `git tag v<major>.<minor>.<patch>` | ||
- Push the tag to upstream using `git push upstream v<major>.<minor>.<patch>` | ||
- This tag will kick-off the [GitHub Release Workflow](https://github.com/qonto/database-monitoring-framework/blob/main/.github/workflows/release.yaml), which will auto-generate GitHub release and publish Helm charts into the container registry |