diff --git a/docs/release-process.md b/docs/release-process.md index c53ea4423eb1dbf521d13286448f33a9613b71ef..5a63d59a13a09b19c43e02d26af45c2dc38d5722 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -6,18 +6,19 @@ nav_order: 2 # Release Process -We assume that we are creating the release `v0.1.1`. Please make sure to adjust +This document describes how to perform a new Theodolite release. + +We assume that we are creating the release `v0.3.1`. Please make sure to adjust the following steps according to the release, you are actually performing. -1. Create a new branch `v0.1` if not already exists. This branch will never +1. Create a new branch `v0.3` if it does not already exists. This branch will never again be merged into master. -2. Checkout the `v0.1` branch. +2. Checkout the `v0.3` branch. -3. Update all references to Theodolite Docker images to tag `v0.1.1`. These are -mainly the Kubernetes resource definitions in `execution` as well as the Docker -Compose files in `docker-test`. +3. Update all references to Theodolite Docker images to tag `v0.1.1`. These are the Kubernetes resource definitions in +`execution`, the Docker Compose files in `docker-test` and the example `theodolite.yaml` job. 4. Commit these changes. -5. Tag this commit with `v0.1.1`. The corresponding Docker images will be uploaded. +5. Tag this commit with `v0.3.1`. The corresponding Docker images will be uploaded.