README.md

Rust example for benchmarking with cargo bench

• Workflow for this example
• Action log of this example
• Benchmark results on GitHub pages

This directory shows how to use github-action-benchmark with cargo bench.

Run benchmarks

Official documentation for usage of cargo bench:

https://doc.rust-lang.org/unstable-book/library-features/test.html

e.g.

- name: Run benchmark
  run: cargo +nightly bench | tee output.txt

Note that cargo bench is available only with nightly toolchain.

Note that this example does not use LTO for benchmarking because entire code in benchmark iteration will be removed as dead code. For normal use case, please enable it in Cargo.toml for production performance.

[profile.bench]
lto = true

Process benchmark results

Store the benchmark results with step using the action. Please set cargo to tool input.

- name: Store benchmark result
  uses: benchmark-action/github-action-benchmark@v1
  with:
    tool: 'cargo'
    output-file-path: output.txt

Please read 'How to use' section for common usage.