Cookiecutter & Revamp #4
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: Tests | |
| on: | |
| push: | |
| branches: [main, master] | |
| pull_request: | |
| branches: [main, master] | |
| jobs: | |
| tests: | |
| name: ${{ matrix.session }} / py${{ matrix.python }} / ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - { python: "3.13", os: "ubuntu-latest", session: "pre-commit" } | |
| - { python: "3.13", os: "ubuntu-latest", session: "safety" } | |
| - { python: "3.13", os: "ubuntu-latest", session: "mypy" } | |
| - { python: "3.12", os: "ubuntu-latest", session: "mypy" } | |
| - { python: "3.11", os: "ubuntu-latest", session: "mypy" } | |
| - { python: "3.10", os: "ubuntu-latest", session: "mypy" } | |
| - { python: "3.9", os: "ubuntu-latest", session: "mypy" } | |
| - { python: "3.13", os: "ubuntu-latest", session: "tests" } | |
| - { python: "3.12", os: "ubuntu-latest", session: "tests" } | |
| - { python: "3.11", os: "ubuntu-latest", session: "tests" } | |
| - { python: "3.10", os: "ubuntu-latest", session: "tests" } | |
| - { python: "3.9", os: "ubuntu-latest", session: "tests" } | |
| - { python: "3.12", os: "windows-latest", session: "tests" } | |
| - { python: "3.12", os: "macos-latest", session: "tests" } | |
| - { python: "3.12", os: "ubuntu-latest", session: "typeguard" } | |
| - { python: "3.13", os: "windows-latest", session: "tests" } | |
| - { python: "3.13", os: "macos-latest", session: "tests" } | |
| - { python: "3.13", os: "ubuntu-latest", session: "xdoctest" } | |
| - { python: "3.13", os: "ubuntu-latest", session: "docs-build" } | |
| env: | |
| NOXSESSION: ${{ matrix.session }} | |
| FORCE_COLOR: "1" | |
| PRE_COMMIT_COLOR: "always" | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v1 | |
| - name: Create uv virtual environment | |
| run: uv venv | |
| - name: Install Nox | |
| run: uv pip install nox | |
| - name: Install dependencies | |
| run: | | |
| uv venv | |
| # CORRECTED: Install the package itself in editable mode (-e) | |
| # along with all optional dependencies for testing. | |
| uv pip install -e ".[dev,docs,lint,mypy,typeguard,xdoctest]" | |
| # The pre-commit cache steps remain the same... | |
| - name: Compute pre-commit cache key | |
| if: matrix.session == 'pre-commit' | |
| id: pre-commit-cache | |
| shell: python | |
| run: | | |
| import hashlib | |
| import sys | |
| python = "py{}.{}".format(*sys.version_info[:2]) | |
| payload = sys.version.encode() + sys.executable.encode() | |
| digest = hashlib.sha256(payload).hexdigest() | |
| result = "${{ runner.os }}-{}-{}-pre-commit".format(python, digest[:8]) | |
| print(f"result={result}") | |
| - name: Restore pre-commit cache | |
| uses: actions/cache@v4 | |
| if: matrix.session == 'pre-commit' | |
| with: | |
| path: ~/.cache/pre-commit | |
| key: ${{ steps.pre-commit-cache.outputs.result }}-${{ hashFiles('.pre-commit-config.yaml') }} | |
| restore-keys: | | |
| ${{ steps.pre-commit-cache.outputs.result }}- | |
| - name: Run Nox | |
| run: | | |
| # The NOXSESSION environment variable tells nox which session to run | |
| nox | |
| - name: Upload coverage data | |
| if: always() && matrix.session == 'tests' | |
| uses: "actions/upload-artifact@v4" | |
| with: | |
| name: coverage-data-${{ matrix.session }}-${{ matrix.python }}-${{ matrix.os }} | |
| path: ".coverage.*" | |
| if-no-files-found: ignore | |
| include-hidden-files: true | |
| - name: Upload documentation | |
| if: matrix.session == 'docs-build' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| path: docs/_build | |
| coverage: | |
| runs-on: ubuntu-latest | |
| needs: tests | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.13" | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v1 | |
| - name: Create uv virtual environment | |
| run: uv venv | |
| - name: Install Nox | |
| run: uv pip install nox | |
| - name: Install dependencies | |
| run: | | |
| # CORRECTED: The coverage job also needs the dev dependencies | |
| uv pip install -e ".[dev,docs,lint,mypy,typeguard,xdoctest]" | |
| - name: Download coverage data | |
| uses: actions/download-artifact@v4 | |
| with: | |
| pattern: coverage-data-* | |
| merge-multiple: true | |
| - name: Combine coverage data and display human readable report | |
| run: | | |
| python -m nox --session=coverage | |
| - name: Create coverage report | |
| run: | | |
| python -m nox --session=coverage -- xml -i | |
| - name: Upload coverage report | |
| uses: codecov/codecov-action@v4 | |
| env: | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| with: | |
| files: ./coverage.xml |