JOSS paper #11
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: verify tests pass and docs build | |
on: | |
push: | |
branches: [main] | |
pull_request: | |
jobs: | |
tests: | |
runs-on: ubuntu-24.04 | |
continue-on-error: ${{ matrix.experimental }} | |
strategy: | |
fail-fast: true | |
matrix: | |
python-version: ["3.10", "3.11", "3.12"] | |
experimental: [false] | |
include: | |
- python-version: "3.13" | |
experimental: true | |
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 pip | |
run: | | |
pip install --upgrade pip | |
- name: Install vanilla package | |
run: | | |
pip install . | |
- name: Install test dependencies | |
run: | | |
pip install .[test] | |
- name: Lint with ruff | |
run: | | |
ruff check . | |
- name: Check types with MyPy | |
run: | | |
mypy src/mpol --pretty | |
- name: Run tests with coverage | |
run: | | |
pytest --cov=mpol | |
docs_build: | |
runs-on: ubuntu-24.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.12" | |
- name: Install doc dependencies | |
run: | | |
pip install .[dev] | |
- name: Install Pandoc dependency | |
run: | | |
sudo apt-get install pandoc | |
- name: Build the docs | |
run: | | |
make -C docs clean | |
make -C docs html |