From 455bdfafa9cfa9ea761afab4ac2f5593b42bfa59 Mon Sep 17 00:00:00 2001 From: Everett Pompeii Date: Fri, 12 Jan 2024 08:50:05 -0500 Subject: [PATCH] Add README --- .github/workflows/pr_benchmarks.yml | 1 + .github/workflows/pr_target_benchmarks.yml | 2 +- .github/workflows/pr_track_benchmarks.yml | 2 +- README.md | 11 +++++++++++ 4 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/.github/workflows/pr_benchmarks.yml b/.github/workflows/pr_benchmarks.yml index c29f963..c4cb1cf 100644 --- a/.github/workflows/pr_benchmarks.yml +++ b/.github/workflows/pr_benchmarks.yml @@ -4,6 +4,7 @@ jobs: benchmark_pr_with_bencher: if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository permissions: + pull-requests: write issues: write name: Continuous Benchmarking with Bencher runs-on: ubuntu-latest diff --git a/.github/workflows/pr_target_benchmarks.yml b/.github/workflows/pr_target_benchmarks.yml index 5758e12..b1f5e73 100644 --- a/.github/workflows/pr_target_benchmarks.yml +++ b/.github/workflows/pr_target_benchmarks.yml @@ -14,7 +14,7 @@ jobs: env: BENCHER_PROJECT: example BENCHER_ADAPTER: json - BENCHER_TESTBED: ubuntu-latest + BENCHER_TESTBED: ubuntu-latest-target steps: - uses: actions/checkout@v4 with: diff --git a/.github/workflows/pr_track_benchmarks.yml b/.github/workflows/pr_track_benchmarks.yml index cab9324..0ef1043 100644 --- a/.github/workflows/pr_track_benchmarks.yml +++ b/.github/workflows/pr_track_benchmarks.yml @@ -13,7 +13,7 @@ jobs: env: BENCHER_PROJECT: example BENCHER_ADAPTER: json - BENCHER_TESTBED: ubuntu-latest + BENCHER_TESTBED: ubuntu-latest-track BENCHMARK_RESULTS: benchmark_results.json PR_EVENT: event.json steps: diff --git a/README.md b/README.md new file mode 100644 index 0000000..36f2df4 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Bencher Examples + +[Bencher](https://bencher.dev) is a suite of [continuous benchmarking](https://bencher.dev/docs/explanation/continuous-benchmarking/) tools. +The `.github` directory contains example workflows from [how to use Bencher in GitHub Actions](https://bencher.dev/docs/how-to/github-actions/). + +- [Benchmark pushes to `main` branch](.github/workflows/benchmarks.yml) +- [Benchmark pull requests from branches](.github/workflows/pr_benchmarks.yml) +- [Benchmark fork pull requests with Required Reviewers](.github/workflows/pr_target_benchmarks.yml) +- Benchmark fork pull requests and upload from default branch + - [Run benchmarks and cache](.github/workflows/pr_and_cache_benchmarks.yml) + - [Track benchmarks](.github/workflows/pr_track_benchmarks.yml)