matchai / criterion-compare-action

criterion-compare

Compare the performance of a PR against master

👋 I've stopped working on this project, but the kind folks at boa-devs will continue working on it over at boa-dev/criterion-compare-action

⚠️ Performance benchmarks provided by this action may fluctuate as load on GitHub Actions does. Run benchmarks locally before making any decisions based on the results.

A GitHub action that will compare the benchmark output between a PR and master, using the project's criterion.rs benchmarks.

Example

Usage

Create a .github/workflows/pull_request.yml workflow file in your repo:

# .github/workflows/pull_request.yml

on: [pull_request]
name: benchmark pull requests
jobs:
  runBenchmark:
    name: run benchmark
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: run benchmark
        uses: matchai/criterion-compare-action@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}