code-quality-checks.yml

name: Code quality checks

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  code_quality:
    name: Check code quality

    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
        python-version: ["3.9", "3.10", "3.11", "3.12"] # TODO 3.8 won't work

    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install dependencies
        run: sh bin/cicd_install.sh

      - name: Check code formatting
        run: make formatcheck

      - name: Check for linter errors
        run: make lint

      - name: Check docstring formatting
        run: make doccheck 

      - name: Check doc site build
        run: make docs

      - name: Check type annotations
        run: make typecheck

      - name: Run tests
        run: make test

      - name: Check code coverage
        run: make covcheck

      - name: Check build
        run: poetry build