ci.yml

---

name: CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
  schedule:
    # * is a special character in YAML so you have to quote this string
    # Run at 1:00 every day
    - cron: '0 1 * * *'

jobs:
  build:

    strategy:
      matrix:
        python-version: ["3.12"]
        platform: [ubuntu-latest]

    runs-on: ${{ matrix.platform }}

    steps:
      - uses: actions/checkout@v4
      - name: "Set up Python"
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - uses: actions/cache@v4
        env:
          UV_CACHE_DIR: ~/.cache/uv
        with:
          path: "${{ env.UV_CACHE_DIR }}"
          key: ${{ runner.os }}-uv-${{ hashFiles('pyproject.toml') }}
          restore-keys: |
            ${{ runner.os }}-uv-

      - name: "Install dependencies"
        env:
          # `/home/runner` is the result of running `readlink -f ~` on the runner.
          UV_CACHE_DIR: /home/runner/.cache/uv
        run: |
          curl -LsSf https://astral.sh/uv/install.sh | sh
          uv venv ${{ github.workspace }}/.venv
          source ${{ github.workspace }}/.venv/bin/activate
          uv pip install --upgrade --editable .[dev]

      - name: "Lint"
        run: |
          source ${{ github.workspace }}/.venv/bin/activate
          make lint

      - name: "Run tests"
        run: |
          source ${{ github.workspace }}/.venv/bin/activate
          # We run tests against "." and not the tests directory as we test the README
          # and documentation.
          pytest -s -vvv --cov-fail-under 100 --cov=src/ --cov=tests . --cov-report=xml

      - name: "Upload coverage to Codecov"
        uses: "codecov/codecov-action@v4"