Add mypy type checking to GitHub CI workflow #123
Workflow file for this run
This file contains hidden or 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: CI | |
| on: | |
| - push | |
| - pull_request | |
| jobs: | |
| test: | |
| name: Run unit tests | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "pypy-3.8", "pypy-3.9"] | |
| steps: | |
| - name: Checkout source code | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python ${{ matrix.python }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Install dependencies | |
| run: python -m pip install tox ruff mypy | |
| - name: Run ruff | |
| run: ruff check . | |
| - name: Run ruff format | |
| run: ruff format --check . | |
| - name: Run mypy type checking | |
| run: mypy fixtures/ --exclude fixtures/tests/ | |
| - name: Run unit tests (via tox) | |
| # Run tox using the version of Python in `PATH` | |
| run: tox -e py | |
| docs: | |
| name: Build docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout source code | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: python -m pip install docutils | |
| - name: Build docs | |
| run: rst2html.py README.rst README.html | |
| if: matrix.python == '3.8' | |
| - name: Build docs | |
| run: rst2html README.rst README.html | |
| if: matrix.python != '3.8' | |
| - name: Archive build results | |
| uses: actions/upload-artifact@v4.6.0 | |
| with: | |
| name: html-docs-build | |
| path: README.html | |
| retention-days: 7 | |
| release: | |
| name: Upload release artifacts | |
| runs-on: ubuntu-latest | |
| needs: test | |
| if: github.event_name == 'push' | |
| steps: | |
| - name: Checkout source code | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: python -m pip install build | |
| - name: Build a binary wheel and a source tarball | |
| run: python -m build --sdist --wheel --outdir dist/ . | |
| - name: Publish distribution to PyPI | |
| if: startsWith(github.ref, 'refs/tags') | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| password: ${{ secrets.PYPI_API_TOKEN }} |