test-type-lint.yaml

name: Build & run pytest-mypy-linters
env:
    IN_GITHUB_ACTION: 1

on: [push]

permissions:
  contents: read

jobs:
  run-on-ubuntu:
    runs-on: ubuntu-latest
    strategy:
      max-parallel: 5

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.11
      uses: actions/setup-python@v5
      with:
        python-version: '3.11'

    # Building/caching the environment

    - name: Add conda to system path
      run: |
        # $CONDA is an environment variable pointing to the root of the miniconda directory
        echo $CONDA
        echo $CONDA/bin >> $GITHUB_PATH
        echo $CONDA_PREFIX

    - name: Cache conda env
      id: cache-conda
      uses: actions/cache@v4
      env:
        # change name here (only) to invalidate cache
        cache-name: cache-conda-env-v1
      with:
          key: ${{ env.cache-name }}-${{ hashFiles('pyproject.toml') }}
          path: ./ci_env

    - name: Create conda env
      run: |
        # creates the env if it does not exist (not loaded from cache)
        sudo apt-get update
        if [ ! -d "./ci_env" ]; then \
          conda create -p ./ci_env python=3.11 ipython -y
        fi

    - name: Install dependencies
      run: |
        source activate ./ci_env
        pip install -e .[dev]

    - name: Print installed packages
      run: |
        source activate ./ci_env
        pip freeze

    # start checks

    - name: Run type hint checks with mypy
      run: |
        source activate ./ci_env
        pip show mypy
        mypy exca

    - name: Test with pytest
      run: |
        source activate ./ci_env
        pip show pytest
        pytest exca --durations=10
        python -m exca.test_safeguard  # checks no unneeded imports

    # TODO: re-enable once docs/steps/ pseudocode blocks are fixed or excluded
    - name: Test README code blocks
      if: false
      run: |
        source activate ./ci_env
        # update readmes to avoid running on slurm:
        sed -i 's/cluster: slurm/cluster: null/g' docs/infra/*.md
        sed -i 's/\"auto\"/None/g' README.md
        # on Mac: sed -i '' 's/cluster: slurm/cluster: null/g' docs/infra/*.md
        # check readmes (only README.md and docs/ folder, not internal specs)
        pytest --markdown-docs -m markdown-docs README.md docs/

    # keep ruff version in sync with .pre-commit-config.yaml
    - uses: astral-sh/ruff-action@v3
      with:
        version: "0.15.8"
        args: "check"
    - uses: astral-sh/ruff-action@v3
      with:
        version: "0.15.8"
        args: "format --check"