Development Guide

Automation

Release Process

Release automation is based on a tagged commit (i.e. named release: v0.0.1 with associated annotated tag v0.0.1) Such a commit should have the following content:

  1. The version in docs/antora.yml changed to a matching tag

  2. Release notes named after tag tag.adoc in docs/modules/ROOT/pages/release_notes/

  3. New release included in docs/modules/ROOT/pages/release_notes.adoc

Above steps are provided by scripts/release.sh

Such tagged commit triggers a job in CircleCI which will:

  1. Build and push tagged docker image to quay.io registry

  2. Push cross-compiled binaries and release notes

Diagram below describes the entire process and its artifacts.

Release automation
Figure 1. Release automation