Release Guidelines for the CaosDB Server
This document specifies release guidelines in addition to the general release guidelines of the CaosDB Project (RELEASE_GUIDELINES.md)
General Prerequisites
- All tests are passing.
- CHANGELOG.md is up-to-date.
Steps
-
Create a release branch from the dev branch. This prevents further changes to the code base and a never ending release process. Naming:
release-<VERSION>
-
Check all general prerequisites.
-
Update the versions in:
CHANGELOG.md
-
compose/docker-compose.yml
in thecaosdb-server.image
section
-
Merge the release branch into the main branch.
-
Tag the latest commit of the main branch with
v<VERSION>
. -
Delete the release branch.
-
Merge the main branch back into the dev branch and set the image tag to a
-dev
version. -
Build the docker image according to the
README_SETUP.md
, tag it ascaosdb/caosdb:<version>
, and push it to docker hub. -
Update the versions for the next developement round:
-
CHANGELOG.md
: Re-add the[Unreleased]
section.
-
Add a gitlab release in the respective repository: https://gitlab.indiscale.com/caosdb/src/caosdb-docker/-/releases
Add a description, which can be a copy&paste from the CHANGELOG, possibly prepended by: