codspeed.yml

name: CodSpeed Benchmarks

on:
  push:
    branches:
      - "main"
  pull_request:
    types: [labeled, synchronize]
  # `workflow_dispatch` allows CodSpeed to trigger backtest
  # performance analysis in order to generate initial data.
  workflow_dispatch:

permissions:
  contents: read

jobs:
  benchmarks:
    name: Run benchmarks
    runs-on: codspeed-macro
    # Only run benchmarks for: pushes to main, manual triggers, or PRs with 'benchmark' label
    if: |
      github.event_name == 'push' ||
      github.event_name == 'workflow_dispatch' ||
      (github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'benchmark'))
    steps:
    - uses: actions/checkout@v6
      with:
        fetch-depth: 0  # grab all branches and tags
    - name: Set up Python
      uses: actions/setup-python@v6
      with:
        python-version: "3.11"
    - name: Install Hatch
      uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc
      with:
        version: '1.16.5'
    - name: Run the benchmarks
      uses: CodSpeedHQ/action@v4
      with:
          mode: walltime
          run: hatch run test.py3.11-minimal:pytest tests/benchmarks --codspeed