lint.yaml

name: Lint

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  lint:
    runs-on: ubuntu-latest

    continue-on-error: true

    steps:
    - uses: actions/checkout@v3

    - uses: actions/setup-python@v4
      with:
        # If the "Latest version testable on GitHub Actions" in pytest.yaml
        # is not the latest 3.x stable version, adjust here to match:
        python-version: "3.10"

    - name: Upgrade pip, wheel, setuptools-scm
      run: |
        python -m pip install --upgrade pip wheel setuptools-scm twine
        # Locate pip cache directory
        echo "pip-cache-dir=$(pip cache dir)" >> $GITHUB_ENV

    - name: Cache Python packages
      uses: actions/cache@v3
      with:
        path: ${{ env.pip-cache-dir }}
        key: lint-${{ runner.os }}

    - name: Upgrade pip, wheel, setuptools-scm
      run: python -m pip install --upgrade pip wheel setuptools-scm

    - name: Check "black" code style
      run: |
        pip install black
        black --check .

    - name: Lint with flake8 & isort
      run: |
        pip install flake8 isort
        flake8 --count --max-complexity=26 --show-source --statistics
        isort --check-only .

    - name: Check typing with mypy
      run: |
        pip install mypy
        # Also install packages that contain type hints
        pip install pytest genno GitPython xarray sphinx types-setuptools
        mypy .