Build automation¶
OpenQL employs continuous integration based on GitHub Actions, to ensure that new features or modifications actually
work on all supported systems. The files to this end are in the .github directory of the repository. Furthermore,
ReadTheDocs can build and publish documentation for OpenQL automatically, for which the files are in the docs
folder (specifically, it uses the docs/.conda.yml file for the Conda environment and then just runs
the makefile in docs).
Integration tests¶
The integration tests are run when you push to a branch for which a pull request is open, or when develop changes.
The suite runs the following things:
the Python test suite;
the ctest suite (tests and examples); and
the standalone C++ test, built completely out of context.
The former two are run on ubuntu-latest, macos-latest, and windows-latest for all active Python versions
(currently 3.6 through 3.9). The latter is only run on ubuntu-latest, as it doesn’t check much except inclusion
of the project via CMake.
Note
To test an incomplete branch that you’re still working on, please open a draft pull request.
Release automation¶
Release artifact generation triggers on a push to a branch that starts with release_ (used for testing) or when
a new release is made via GitHub and/or a tag is pushed.
Warning
Please don’t do any of these things until you have read the Release procedure!
ReadTheDocs automation¶
TODO: Razvan, anything noteworthy here?