https://github.com/boa-dev/criterion-compare-action

⚡️📊 Compare the performance of Rust project branches
https://github.com/boa-dev/criterion-compare-action

benchmark criterion github-actions hacktoberfest rust

Last synced: about 2 months ago
JSON representation

⚡️📊 Compare the performance of Rust project branches

• Host: GitHub
• URL: https://github.com/boa-dev/criterion-compare-action
• Owner: boa-dev
• License: isc
• Created: 2019-09-18T22:27:53.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-06T08:21:49.000Z (6 months ago)
• Last Synced: 2024-05-11T06:38:56.461Z (4 months ago)
• Topics: benchmark, criterion, github-actions, hacktoberfest, rust
• Language: JavaScript
• Homepage:
• Size: 678 KB
• Stars: 61
• Watchers: 5
• Forks: 25
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# criterion-compare

Compare the performance of a PR against the base branch.

---

> ⚠️ 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 the base branch, using the project's [criterion.rs](https://github.com/bheisler/criterion.rs/) benchmarks.

## Example

![Example benchmark comparison comment](image.png)

## Usage

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

```yml

on: [pull_request]

name: benchmark pull requests

jobs:

  runBenchmark:

    name: run benchmark

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - uses: boa-dev/criterion-compare-action@v3

        with:

          cwd: "subDirectory (optional)"

          # Optional. Compare only this package

          package: "example-package"

          # Optional. Compare only this benchmark target

          benchName: "example-bench-target"

          # Optional. Disables the default features of a crate

          defaultFeatures: false

          # Optional. Features activated in the benchmark

          features: "async,tokio-support"

          # Needed. The name of the branch to compare with. This default uses the branch which is being pulled against

          branchName: ${{ github.base_ref }}

          # Optional. Default is `${{ github.token }}`.

          token: ${{ secrets.GITHUB_TOKEN }}

```

## Troubleshooting

### `Unrecognized option: 'save-baseline'`

If you encounter this error, you can check [this Criterion FAQ](https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options), to find a workaround.