Skip to content

Commit

Permalink
chore(RELEASE): Document the process
Browse files Browse the repository at this point in the history
  • Loading branch information
vmercierfr committed May 17, 2024
1 parent bf8de46 commit a9a62c4
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions RELEASE.md
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

0 comments on commit a9a62c4

Please sign in to comment.