README.md

Bencher Examples

Bencher is a suite of continuous benchmarking tools. The .github directory contains example workflows from how to use Bencher in GitHub Actions.

• Benchmark pushes to main branch
• Benchmark pull requests
  • Run and track benchmarks
  • Archive branches for closed pull requests
• Benchmark pull requests from forks
  • Run benchmarks
  • Track benchmarks
  • Archive branches for closed pull requests from forks
• Benchmark pull requests on Bare Metal
  • Submit benchmarks as Jobs
  • Post results of finished Jobs to pull requests

These examples use the Bencher CLI GitHub Action. The bare metal example's benchmark Image is the Bencher CLI image, whose entrypoint is bencher and which has no shell, so its benchmark command is mock with --exec.