Skip to content

Commit

Permalink
Merge pull request #30 from qonto/add-release
Browse files Browse the repository at this point in the history
Document the release process
  • Loading branch information
vmercierfr authored May 17, 2024
2 parents 1328088 + b8c9ccf commit 438aa6f
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions RELEASE.md
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

0 comments on commit 438aa6f

Please sign in to comment.