ci.yml

name: CI
on:
  - push
  - pull_request
jobs:
  setup:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest]
    steps:
      - name: Cache StatsBomb test data
        id: cache-statsbomb
        uses: actions/cache@v4
        with:
          path: tests/datasets/statsbomb
          key: cache-statsbomb-data
      - name: Cache public Wyscout test data
        id: cache-public-wyscout
        uses: actions/cache@v4
        with:
          path: tests/datasets/wyscout_public
          key: cache-public-wyscout-data
      - name: Check out the repository
        if: steps.cache-statsbomb.outputs.cache-hit != 'true' || steps.cache-public-wyscout.outputs.cache-hit != 'true'
        uses: actions/checkout@v4
      - name: Set up Python
        if: steps.cache-statsbomb.outputs.cache-hit != 'true' || steps.cache-public-wyscout.outputs.cache-hit != 'true'
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Upgrade pip
        if: steps.cache-statsbomb.outputs.cache-hit != 'true' || steps.cache-public-wyscout.outputs.cache-hit != 'true'
        run: |
          pip install --constraint=.github/workflows/constraints.txt pip
          pip --version
      - name: Install Poetry
        if: steps.cache-statsbomb.outputs.cache-hit != 'true' || steps.cache-public-wyscout.outputs.cache-hit != 'true'
        run: |
          pip install --constraint=.github/workflows/constraints.txt poetry
          poetry --version
      - name: Install Nox
        if: steps.cache-statsbomb.outputs.cache-hit != 'true' || steps.cache-public-wyscout.outputs.cache-hit != 'true'
        run: |
          pip install --constraint=.github/workflows/constraints.txt nox nox-poetry
          nox --version
      - name: Install dependencies
        if: steps.cache-statsbomb.outputs.cache-hit != 'true' || steps.cache-public-wyscout.outputs.cache-hit != 'true'
        run: poetry install --no-dev
        env:
          PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
      - name: Download StatsBomb test data
        if: steps.cache-statsbomb.outputs.cache-hit != 'true'
        run: poetry run python tests/datasets/download.py --download-statsbomb
      - name: Download Wyscout test data
        if: steps.cache-public-wyscout.outputs.cache-hit != 'true'
        run: poetry run python tests/datasets/download.py --download-wyscout
  tests:
    name: ${{ matrix.session }} ${{ matrix.python-version }} / ${{ matrix.os }}
    needs: setup
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - { python-version: "3.12", os: ubuntu-latest, session: "pre-commit" }
          - { python-version: "3.12", os: ubuntu-latest, session: "mypy" }
          - { python-version: "3.12", os: ubuntu-latest, session: "tests" }
          - { python-version: "3.11", os: ubuntu-latest, session: "tests" }
          - { python-version: "3.10", os: ubuntu-latest, session: "tests" }
          - { python-version: "3.9", os: ubuntu-latest, session: "tests" }
          - { python-version: "3.12", os: windows-latest, session: "tests" }
          - { python-version: "3.12", os: ubuntu-latest, session: "docs-build" }
    env:
      NOXSESSION: ${{ matrix.session }}
    steps:
      - name: Check out the repository
        uses: actions/checkout@v4
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Upgrade pip
        run: |
          pip install --constraint=.github/workflows/constraints.txt pip
          pip --version
      - name: Install Poetry
        run: |
          pip install --constraint=.github/workflows/constraints.txt poetry
          poetry --version
      - name: Install Nox
        run: |
          pip install --constraint=.github/workflows/constraints.txt nox nox-poetry
          nox --version
      - name: Load cached StatsBomb test data
        if: matrix.session == 'tests'
        id: cache-statsbomb
        uses: actions/cache@v4
        with:
          path: tests/datasets/statsbomb
          key: cache-statsbomb-data
      - name: Load cached Wyscout test data
        if: matrix.session == 'tests'
        id: cache-public-wyscout
        uses: actions/cache@v4
        with:
          path: tests/datasets/wyscout_public
          key: cache-public-wyscout-data
      - 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
        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: |
          nox --force-color --python=${{ matrix.python-version }}
      - name: Upload coverage data
        if: always() && matrix.session == 'tests' && matrix.os == 'ubuntu-latest'
        uses: "actions/upload-artifact@v4"
        with:
          name: coverage-data-${{ matrix.os }}-${{ matrix.python-version }}
          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.11
        uses: actions/setup-python@v5
        with:
          python-version: 3.11
      - name: Upgrade pip
        run: |
          pip install --constraint=.github/workflows/constraints.txt pip
          pip --version
      - name: Install Poetry
        run: |
          pip install --constraint=.github/workflows/constraints.txt poetry
          poetry --version
      - name: Install Nox
        run: |
          pip install --constraint=.github/workflows/constraints.txt nox nox-poetry
          nox --version
      - 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: |
          nox --force-color --session=coverage
      - name: Create coverage report
        run: |
          nox --force-color --session=coverage -- xml
      - name: Upload coverage report
        uses: codecov/codecov-action@v4