Skip to content

Continuous Integration

ANTARES SIMULATOR's compilation is fully tested on GitHub CI.

Here is a description of workflows with their associated status.

Build & release workflows

OS .yml Description Status
Ubuntu ubuntu.yml Builds Antares Simulator Status
Windows windows-vcpkg.yml Builds Antares Simulator Status
Centos7 centos7.yml Builds Antares Simulator Status
OracleLinux8 oracle8.yml Builds Antares Simulator Status
- build-userguide.yml Generates PDF user guide from material in docs/user-guide (uses Sphinx) Status
All of the above new_release.yml When a release is created, runs the aforementioned workflows and publishes their assets Status

Additional workflows

.yml Description Status
sonarcloud.yml Compilation with specific options for sonarcloud analysis Status
branchNameValidation.yml This workflow verifies that new branches respect Antares Simulator Team's naming conventions[^1]
docker.yml Builds and pushes "centos7-basic-requirements" docker image
doxygen.yml Builds & publishes the doxygen documentation
download-extract-precompiled-libraries-tgz/action.yml Download and extract .tgz precompiled libraries from antares-deps repository
download-extract-precompiled-libraries-zip/action.yml Download and extract .zip precompiled libraries from antares-deps repository
install-cmake-328/action.yml Installs cmake 3.28 using devtoolset 10
run-tests/action.yml Runs tests on the simulator using reference study batches here
clang-format.yml Check formatting using clang-format 18.1.3 through bash script src/format-code.sh[^2]
[^1]: all branch names must start with feature/, features/, fix/, release/, doc/, issue-, or dependabot/; otherwise the workflows are not run
[^2]: please note that this job must succeed in order to merge PRs