Skip to content

Commit

Permalink
Merge pull request #175 from qonto/add-release
Browse files Browse the repository at this point in the history
Document release process
  • Loading branch information
vmercierfr authored May 17, 2024
2 parents bf8de46 + c0eb254 commit 863aeac
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 49 deletions.
27 changes: 27 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Release Process

## Overview

The Prometheus RDS exporter project has the following components:

- Prometheus RDS exporter binary
- Docker image
- Helm chart
- Debian package

## 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 with multi-architecture binaries and Debian package, publish new release of amd64/arm64 docker images and Helm charts into the container registry
49 changes: 0 additions & 49 deletions docs/manual-release.md

This file was deleted.

0 comments on commit 863aeac

Please sign in to comment.