Introduction

ParaView CI Example is an example on how to build, test and release a ParaView plugin using CI. It contains only a very simple ParaView plugin 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 github to be able to build and test your ParaView plugin.

This example is developed by Kitware SAS.

Build and test with a ParaView image

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

Graphical testing is supported using xvfb-run.

Building a plugin for the paraview.org binary release

The provided yml files also build a plugin compatible with the multiple paraview.org binary releases. The artifact can be recovered and contains the binary compatible plugin. To select the version, keep the steps using the right image tag. Available images are visible on paraview_org-plugin-devel dockerhub repository.

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 ParaView License.

Technicalities

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

In the GitHub example, the binary compatibility job cannot use gitub action from the marketplace as the docker container used is not compatible with node 20. Instead, we show how to upload using a dedicated REST API from data.kitware.com, you may want to use rewrite this action and upload to another server with a dedicated API, but you cannot use GitHub actions.

In the GitLab example, jobs can be disabled using CI variables. eg: set DISABLE_5_10 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.

Deprecated Variables

Previous CI variables names with the DISABLE_vNMP syntax have been deprecated and should not be used. Please use the new syntax, DISABLE_N_M instead.