example.yml

# Example consumer workflow.
#
# Drop a copy of this into YOUR repository at .github/workflows/profile-diff.yml
# to get a performance-diff comment on every pull request.
name: Profile diff

on:
  pull_request:

# The commenter needs write access to pull requests.
permissions:
  contents: read
  pull-requests: write

jobs:
  profile-diff:
    runs-on: ubuntu-latest
    steps:
      - name: Check out the PR
        uses: actions/checkout@v4
        with:
          # Full history so the base commit can be profiled from a worktree.
          fetch-depth: 0

      # Install whatever your target needs to run (pytest, your package, ...).
      - name: Install project dependencies
        run: python -m pip install -e ".[test]" || pip install pytest

      - name: Profile & diff
        uses: python-testing-debugging/profile-diff-action@v1
        with:
          # Choose ONE target selector:
          target: "--pytest tests/"
          # target: "--script scripts/benchmark.py"
          # target: "--callable mypkg.hotpath:main"
          top: "30"
          threshold-pct: "5"
          fail-on-regression: "false"