Skip to content

Commit 438aa6f

Browse files
authored
Merge pull request #30 from qonto/add-release
Document the release process
2 parents 1328088 + b8c9ccf commit 438aa6f

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

RELEASE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Release Process
2+
3+
## Overview
4+
5+
The Database Monitoring Framework project has the following components:
6+
7+
- prometheus-rds-alerts chart
8+
- prometheus-postgresql-alerts chart
9+
10+
## Versioning Strategy
11+
12+
The project is using [Semantic Versioning](https://semver.org):
13+
14+
- MAJOR version may introduce incompatible changes
15+
- MINOR version introduces functionality in a backward compatible manner
16+
- PATCH version introduces backward compatible bug fixes
17+
18+
## Releasing a New Version
19+
20+
The following steps must be done by one of the Database Monitoring Framework Maintainers:
21+
22+
- Verify the CI tests pass before continuing.
23+
- Create a tag using the current `HEAD` of the `main` branch by using `git tag v<major>.<minor>.<patch>`
24+
- Push the tag to upstream using `git push upstream v<major>.<minor>.<patch>`
25+
- 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 commit comments

Comments
 (0)