Skip to content
Snippets Groups Projects
Code owners
Assign users and groups as approvers for specific file changes. Learn more.

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

  1. 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>

  2. Check all general prerequisites.

  3. Update the versions in:

  • CHANGELOG.md
  • compose/docker-compose.yml in the caosdb-server.image section
  1. Merge the release branch into the main branch.

  2. Tag the latest commit of the main branch with v<VERSION>.

  3. Delete the release branch.

  4. Merge the main branch back into the dev branch and set the image tag to a -dev version.

  5. Build the docker image according to the README_SETUP.md, tag it as caosdb/caosdb:<version>, and push it to docker hub.

  6. Update the versions for the next developement round:

  • CHANGELOG.md: Re-add the [Unreleased] section.
  1. 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:

Changelog

See full changelog ```