-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(RELEASE): Document the process
- Loading branch information
1 parent
bf8de46
commit a9a62c4
Showing
1 changed file
with
29 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,29 @@ | ||
# Release Process | ||
|
||
## Overview | ||
|
||
The Prometheus RDS exporter project has the following two components: | ||
|
||
- Prometheus RDS exporter binary | ||
- Docker image | ||
- Helm chart | ||
- Debian package | ||
|
||
This repository is the home for both of the above components. | ||
|
||
## 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 Prometheus RDS Exporter 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/prometheus-rds-exporter/blob/main/.github/workflows/build.yaml), which will auto-generate GitHub release contains multi-architecture binaries and Debian package, publish new release of amd64/arm64 docker images and Helm charts into the container registry |