This package implements different workflows for CI. They are organised as follows.
The documentation
workflow triggers on any push to master, builds the documentation and pushes it to the gh-pages
branch (if the build is successful).
It runs on ubuntu-latest
and Python 3.x
.
Tests are ensured in the basic_tests
and extended_tests
workflows.
The former runs our most simple tests on all pushes except those to master
, and the latter runs the entire testing suite for all commits related to a pull request
.
Both run on a matrix of all available operating systems for all supported Python versions (currently 3.7
and 3.8
).
Test coverage is calculated in the coverage
wokflow, which triggers on pushes to master
and any push to a pull request
.
It runs on ubuntu-latest
& Python 3.x
, and reports the coverage results of the test suite to CodeClimate
.
A cron
workflow triggers every Monday at 3am (UTC time) and runs the full testing suite, on all available operating systems and supported Python versions.
It also runs on Python 3.x
so that newly released Python versions that would break tests are automatically included.
Publishing to PyPI
is done through the publish
workflow, which triggers anytime a release
is made of the Github repository.
It builds a wheel
, checks it, and pushes to PyPI
if checks are successful.