From a9a62c43fdcf6f10bbc594a37841d0b22c8380f8 Mon Sep 17 00:00:00 2001 From: Vincent Mercier Date: Fri, 17 May 2024 09:11:14 +0200 Subject: [PATCH] chore(RELEASE): Document the process --- RELEASE.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..25bb171 --- /dev/null +++ b/RELEASE.md @@ -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..` +- Push the tag to upstream using `git push upstream v..` +- 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