python_tests.yml

name: Python tests

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
  schedule:
    - cron: "0 4 * * MON"

jobs:
  test:
    strategy:
      fail-fast: false
      matrix:
        platform: [ubuntu-latest, macos-latest, windows-latest]
        python-version: ["3.12"]
        mne-version: [mne-stable]

        include:
          # Test mne development version only on ubuntu
          - platform: ubuntu-latest
            python-version: "3.12"
            mne-version: mne-main
            run-as-extra: true

    runs-on: ${{ matrix.platform }}

    env:
      TZ: Europe/Berlin
      FORCE_COLOR: true
    steps:
    - uses: actions/checkout@v4

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

    - uses: actions/cache@v4
      with:
        path: ${{ env.pythonLocation }}
        key: ${{ env.pythonLocation }}-${{ hashFiles('setup.cfg') }}-${{ hashFiles('requirements-dev.txt') }}

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements-dev.txt
        pip install -e .

    - name: Install MNE-Python (development version)
      if: matrix.mne-version == 'mne-main'
      run: |
        pip install git+https://github.com/mne-tools/mne-python.git@main

    - name: Check installed versions
      run: |
        mne sys_info

    - name: Check formatting
      if: matrix.platform == 'ubuntu-latest'
      run: |
        flake8 --docstring-convention numpy .
        pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )

    - name: Test with pytest
      # Options defined in pyproject.toml
      run: pytest

    - name: Build docs
      run: |
        make -C docs/ clean
        make -C docs/ html

    - name: Upload artifacts
      if: matrix.platform == 'ubuntu-latest'
      uses: actions/upload-artifact@v3
      with:
        name: docs-artifact
        path: docs/_build/html

    - name: Upload coverage report
      uses: codecov/codecov-action@v4
      with:
        token: ${{ secrets.CODECOV_TOKEN }}  # not required but might help API rate limits
        files: ./coverage.xml