ci.yml

name: "Tests"
on:
  pull_request:
    branches:
      - main
    paths:
      - pyprobe/**
      - tests/**
      - docs/source/examples/*ipynb
      - pyproject.toml
      - .github/workflows/ci.yml
      - uv.lock
  push:
    branches:
      - main
    paths:
      - pyprobe/**
      - tests/**
      - pyproject.toml
      - .github/workflows/ci.yml
      - uv.lock
  workflow_dispatch:
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v4
      - name: Install uv
        uses: astral-sh/setup-uv@v5
        with:
          # Install a specific version of uv.
          version: "0.5.22"

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version-file: "pyproject.toml"
      
      - name: Install the project
        run: | # install the project with pybamm for the import pybamm solution test
          uv venv --seed
          uv sync --all-extras --frozen
          source .venv/bin/activate
          uv pip install pybamm

      - name: Run tests
        run: uv run pytest --benchmark-json output.json --cov-report=xml

      - name: Store benchmark result
        uses: benchmark-action/github-action-benchmark@v1
        with:
          name: Python Benchmark with pytest-benchmark
          tool: 'pytest'
          output-file-path: output.json
          # Use personal access token instead of GITHUB_TOKEN due to https://github.community/t/github-action-not-triggering-gh-pages-upon-push/16096
          github-token: ${{ secrets.GITHUB_TOKEN }}
          # Show alert with commit comment on detecting possible performance regression
          alert-threshold: '110%'
          comment-on-alert: true
          # Enable Job Summary for PRs
          summary-always: true
      - name: Test notebooks
        if: github.event_name == 'pull_request'
        run: uv run pytest --nbmake docs/source/examples/*ipynb

      - name: Upload coverage reports to Codecov
        uses: codecov/codecov-action@v5
        with:
          token: ${{ secrets.CODECOV_TOKEN }}