Add README

Author: epompeii

.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

.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:

.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:

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)