This page gathers the tasks to be performed when preparing a release.

Running the sanitized tests

Before a release, the tests shall be run with the sanitizers and the standard library hardening, using the Run sanitizers continuous integration workflow, described below. The sanitizer options themselves are described in Running sanitized tests.

The Run sanitizers workflow

The workflow is defined in .github/workflows/run-sanitizers.yml. It is a manual workflow: it is never triggered automatically by a push or a pull request, and must be started explicitly, either from the web interface or using the GitHub CLI. It runs the standard sequence of the continuous integration (build, build-tests, ctest, install, tfel-check) with the sanitizers and the standard library hardening, using the inputs described below:

Input Description Default
build_type CMake build type: Debug, RelWithDebInfo or Release Debug
compiler C++ compiler: gcc or clang gcc
sanitize_options semicolon separated list of the sanitizers to enable address
glibcxx_debug enable the debug mode of the standard library of the GNU C++ library true

Running the workflow requires write access to the repository. Note that a manual workflow is only proposed for the branches or tags on which the workflow file exists: the file must be present on the selected ref.

Running the workflow from the web interface

The progress of the run is displayed in the Actions tab and the failures are reported as usual in the annotations and in the logs of the failed job.

Running the workflow from the command line

The same workflow can be started with the GitHub CLI (gh), which is convenient to script the checks of a release:

$ gh workflow run run-sanitizers.yml --ref <branch or tag> \
    -f build_type=Debug -f compiler=clang \
    -f 'sanitize_options=address;undefined' -f glibcxx_debug=true

The value of sanitize_options contains a semicolon, which is the command separator of most shells: it shall be quoted.

The runs can be monitored and inspected with:

$ gh run list --workflow run-sanitizers.yml        # list the runs
$ gh run watch <run identifier>                    # follow the progress
$ gh run view --log-failed <run identifier>        # logs of the failed steps

The following two configurations have been validated on a full build with all the tests, including the installation and tfel-check:

Each sanitizer report (address error, leak, undefined behaviour, container out of bounds, etc.) makes the tested program exit with a non zero status and thus makes the corresponding test fail: a green run means that no such report was emitted.