Introduction

VTK CI Example is an example on how to build and test a VTK based application or modules using CI. It contains only a very simple VTK module associated with .gitlab-ci.yml and .github/workflows/ci.yml files.

Everything is handled in the yml files. You can copy the one you need in your own project, on any gitlab instance or on github to be able to build and test your VTK based modules or applications.

This example is developed by Kitware SAS.

Build and test with a VTK image

The provided yml files use multiple VTK versions to build and test. To select the version, keep the steps using the right image tag. Available images are visible on vtk-for-ci dockerhub repository.

Graphical testing is supported using xvfb-run and mesa.

License

This repository is distributed under the OSI-approved BSD 3-clause License. The yml files in the repository can alternatively be used under the CC0 license and, as such, can be copied without mentioning Kitware copyright. See License.txt for details. For additional licenses, refer to the VTK License.

Technicalities

In the .github example, a CI matrix is used to build against different version of VTK. Feel free to modify the values in this matrix as you see fit.

In the .gitlab example, jobs can be disabled using CI variables. eg: set DISABLE_9_0 to True. This can be practical when sharing this file among multiples repositories.

Pointing the .gitlab-ci.yml file directly in your gitlab repository CI settings is possible but it is highly recommended to point to a specific commit version of the file and to not rely on the main branch to ensure continuity of CI.