CI and CD

Trunk

Keeps our code clean, formatted correctly, finds any unused variables, etc.

Pytest

On each PR Pytest is ran to check the output of the code.

CodeQL

CodeQL helps report any vulnerabilities within the code base to keep our code secure.

Dependency Scanner

Dependency scanner checks any dependencies that we are using for any vulnerabilities, to be sure we are not introducing any vulnerabilities into the users computer through our code or any package that we are using.

Docs

Within .github/workflows/docs.yaml is the workflow to build the documentation from docstrings within src/cript/ and MD files then push to the built html and css to gh-pages branch. The repository is configured to listen to the gh-pages branch for any pushes. Once there has been a push to gh-pages GitHub pages deploys deploys the new changes to the repositories GitHub pages URL. The workflow closely follows Material MKDocs documentation. Refer to documentation wiki page for more information