tests.yml

name: Tests
on:
  - push
  - pull_request
jobs:
  tests:
    name: ${{ matrix.session }} ${{ matrix.python-version }} / ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    timeout-minutes: 10
    strategy:
      fail-fast: false
      matrix:
        include:
          - {python-version: "3.9", os: ubuntu-latest, session: "mypy"}
          - {python-version: "3.9", os: ubuntu-latest, session: "tests"}
          - {python-version: "3.10", os: ubuntu-latest, session: "mypy"}
          - {python-version: "3.10", os: ubuntu-latest, session: "tests"}
          - {python-version: "3.11", os: ubuntu-latest, session: "mypy"}
          - {python-version: "3.11", os: ubuntu-latest, session: "tests"}
          - {python-version: "3.12", os: ubuntu-latest, session: "mypy"}
          - {python-version: "3.12", os: ubuntu-latest, session: "tests"}
          - {python-version: "3.12", os: macos-latest, session: "tests"}
          # - { python-version: "3.12", os: windows-latest, session: "tests" }
          - {python-version: "3.9", os: ubuntu-latest, session: "docs-build"}
          - {python-version: "3.12", os: ubuntu-latest, session: "pre-commit"}
          - {python-version: "3.12", os: ubuntu-latest, session: "typeguard"}
          - {python-version: "3.12", os: ubuntu-latest, session: "xdoctest"}
    env:
      NOXSESSION: ${{ matrix.session }}
    steps:
      - name: Check out the repository
        uses: actions/checkout@v4
      - name: Lint with Ruff
        uses: chartboost/ruff-action@v1
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Upgrade pip
        run: |
          pip install pip
          pip --version
      - name: Install Rye
        run: |
          curl -sSf https://rye.astral.sh/get | RYE_INSTALL_OPTION="--yes" bash
          source "$HOME/.rye/env"
          rye --version
      - name: Install Uv
        run: |
          curl -LsSf https://astral.sh/uv/install.sh | sh
          uv --version
      - name: Install Nox
        run: |
          pipx install nox
          nox --version
      - 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("::set-output name=result::{}".format(result))
      - name: Restore pre-commit cache
        uses: actions/cache@v4.0.2
        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: |
          source "$HOME/.rye/env"
          nox --force-color --python=${{ matrix.python-version }}
      - name: Upload coverage data
        if: always() && matrix.session == 'tests'
        uses: "actions/upload-artifact@v4"
        with:
          name: coverage-data-${{ matrix.python-version }}-${{ matrix.os }}
          path: ".coverage.*"
      - 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 3.12
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Upgrade pip
        run: |
          pip install pip
          pip --version
      - name: Install Rye
        run: |
          curl -sSf https://rye.astral.sh/get | RYE_INSTALL_OPTION="--yes" bash
          source "$HOME/.rye/env"
          rye --version
      - name: Install Uv
        run: |
          curl -LsSf https://astral.sh/uv/install.sh | sh
          uv --version
      - name: Install Nox
        run: |
          pip install nox
          nox --version
      - name: Run codecov session
        run: nox --sessions tests-3.12 coverage
        env:
          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}