Skip to content

Github Actions

Richard Stromer edited this page Apr 14, 2023 · 8 revisions

Github actions documentation

Linters

Linters workflow Configuration file

  • black: Code formatting
  • isort: Import sorting and unused imports
  • flake8: PEP8 code style checks
  • pyright: Type checking

Tests

Tests workflow Configuration file

  • Pytest: Run the unit and integration tests for all operating systems (Linux, macOS, Windows) and the latest and oldest python versions, resulting in overall 6 test runs
  • Docs: Build the documentation with Sphinx to make sure it does not fail (requires special pandoc image)

Metrics

Metrics workflow, configuration

CodeQL

CodeQL is a Github service with checks for vulnerabilities, read more at their website.

Clone this wiki locally