This directory contains a number of workflows for use with GitHub Actions. They specify what standards should be expected for development of this software, including pull requests. These workflows are designed to work out of the box for any research software prototype, especially those based on Qiskit.
This workflow checks that the code is formatted properly and follows the style guide by installing tox and running the lint environment (tox -elint).
This workflow installs the latest version of tox and runs the current repository's tests under each supported Python version on Linux and under a single Python version on macOS and Windows. This is the primary testing workflow. It runs for all code changes and additionally once per day, to ensure tests continue to pass as new versions of dependencies are released.
This workflow tests the coverage environment on a single version of Python by installing tox and running tox -ecoverage.
This workflow is only triggered when the CITATION.bib file is changed. It ensures that the file contains only ASCII characters (escaped codes are preferred, as then the bib file will work even when inputenc is not used). It also compiles a sample LaTeX document which includes the citation in its bibliography and uploads the resulting PDF as an artifact so it can be previewed (e.g., before merging a pull request).