benchmark.yml

name: Benchmark XGI
on:
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: write
  deployments: write

jobs:
  benchmark:
    name: Upload XGI benchmarks
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: 3.13
      - name: Install packages
        run: |
          pip install --upgrade pip
          pip install .[benchmark]
      - name: Run benchmarks
        run: |
          pytest benchmarks/*.py --benchmark-json=benchmarks/output.json --benchmark-time-unit=ms   
      - name: Store benchmark results
        uses: benchmark-action/github-action-benchmark@v1
        with:
          name: XGI Benchmarks
          tool: 'pytest'
          output-file-path: benchmarks/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 }}
          auto-push: true
          # Show alert with commit comment on detecting possible performance regression
          alert-threshold: '200%'
          comment-on-alert: false
          fail-on-alert: true