Pull Request Keywords

CI can be configured in a PR through keywords in comments. Here is the list of known keywords:

• [ci-build]: trigger another build.
• [ci-depends-on]: the PR has an external dependency on a non-default branch of an external repository of a plugin compiled by the CI. Example [ci-depends-on https://github.com/sofa-framework/SofaPython3/pull/204]. In case of multiple external dependencies, one line by dependency is required:

[ci-depends-on https://github.com/sofa-framework/SofaPython3/pull/378]
[ci-depends-on https://github.com/sofa-framework/BeamAdapter/pull/119]

• [ci-ignore]: build ignored
• [with-scene-tests]: run the scene tests. Not run by default.
• [with-regression-tests]: run the regression tests. Not run by default.
• [with-all-tests]: run the scene tests and the regression tests. Not run by default.
• [generate-binaries]: generate binaries and a package. See CMake variable SOFA_BUILD_RELEASE_PACKAGE.
• [force-full-build]: By default, the build is incremental. This option forces a full rebuild.

The keywords are detected by CI scripts all along the build process.

Keywords can be combined. For example [ci-build][with-all-tests] triggers another build and runs the scene and regression tests. This recipe is the most used one. Occasionally, one can use the recipe [ci-build][with-all-tests][force-full-build].