Submit benchmark data with one CLI and the framework your team already uses.

Want to confirm the CLI, API key, and dashboard path before wiring a real benchmark suite? Download the sample pytest-benchmark artifact and upload it with your project API key.

perfall ingest pytest-benchmark \
  --file pytest-benchmark-sample.json \
  --api-key "$PERFALL_API_KEY"

name: Perfall benchmark gate

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read
  checks: write
  issues: write

jobs:
  benchmarks:
    runs-on: ubuntu-latest
    env:
      PERFALL_API_KEY: ${{ secrets.PERFALL_API_KEY }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - id: perfall_ingest
        run: |
          python -m pip install --upgrade pip
          python -m pip install perfall-cli pytest pytest-benchmark
          pytest --benchmark-only --benchmark-json benchmark.json
      - run: |
          if [ "$GITHUB_EVENT_NAME" = "pull_request" ]; then
            perfall ingest pytest-benchmark \
              --file benchmark.json \
              --api-key "$PERFALL_API_KEY" \
              --baseline-branch "${{ github.event.pull_request.base.ref }}" \
              --baseline-window 5 \
              --fail-on-regression-percent 5
          else
            perfall ingest pytest-benchmark \
              --file benchmark.json \
              --api-key "$PERFALL_API_KEY"
          fi
      - name: Publish Perfall benchmark check
        if: ${{ always() }}
        uses: actions/github-script@v7
        env:
          PERFALL_DASHBOARD_URL: ${{ steps.perfall_ingest.outputs.perfall_dashboard_url }}
          PERFALL_PR_COMMENT: ${{ steps.perfall_ingest.outputs.perfall_pr_comment_markdown }}
        with:
          script: |
            const summary = process.env.PERFALL_PR_COMMENT || 'Perfall did not publish a benchmark verdict.';
            const failed = summary.includes('Regression gate: **FAILED**');
            const warming = summary.includes('insufficient history');
            await github.rest.checks.create({
              owner: context.repo.owner, repo: context.repo.repo,
              name: 'Perfall benchmark', head_sha: context.sha, status: 'completed',
              conclusion: failed ? 'failure' : warming ? 'neutral' : 'success',
              details_url: process.env.PERFALL_DASHBOARD_URL || undefined,
              output: { title: failed ? 'Regression threshold exceeded' : warming ? 'Warming up: no comparable baseline' : 'Regression gate passed', summary }
            });