Fix pre-commit instructions in CONTRIBUTING #331
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Python tests | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }} | |
| cancel-in-progress: true | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| create: | |
| branches: [main] | |
| tags: ['**'] | |
| schedule: | |
| - cron: "0 4 1 * *" | |
| jobs: | |
| test: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| platform: [ubuntu-22.04, ubuntu-latest, macos-latest, windows-latest] | |
| python-version: ["3.10", "3.11", "3.12"] | |
| env: | |
| TZ: Europe/Berlin | |
| FORCE_COLOR: true | |
| runs-on: ${{ matrix.platform }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install -e .[dev] | |
| - name: install MNE-Python main | |
| if: "matrix.platform == 'ubuntu-22.04'" | |
| run: | | |
| pip install -U git+https://github.com/mne-tools/mne-python | |
| - name: Display versions and environment information | |
| run: | | |
| echo $TZ | |
| date | |
| python --version | |
| which python | |
| mne sys_info | |
| - name: Check formatting | |
| if: ${{ matrix.platform == 'ubuntu-22.04' && matrix.python-version == '3.11' }} | |
| run: | | |
| make check-manifest | |
| pre-commit run --all-files || ( git status --short ; git diff ; exit 1 ) | |
| - name: Test with pytest | |
| run: | | |
| make test | |
| - name: Build docs | |
| run: | | |
| make build-doc | |
| - name: Upload artifacts | |
| if: ${{ matrix.platform == 'ubuntu-22.04' && matrix.python-version == '3.11' }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-artifact | |
| path: docs/_build/html | |
| - name: Upload coverage report | |
| if: ${{ matrix.platform == 'ubuntu-22.04' && matrix.python-version == '3.11' }} | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| files: ./coverage.xml |