Skip to content

build: Run benchmarks in parallel #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pjbgf merged 1 commit into from
Feb 26, 2026
+84 −38
Merged

build: Run benchmarks in parallel #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 84 additions & 26 deletions .github/workflows/bench-regression.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,19 @@

permissions: {}

env:
BENCH_COUNT: 6
BENCH_FILTER: 'BenchmarkCompare/(mem|os)fs'
BENCH_PATH: ./test/...

jobs:
benchmark:
name: Compare Benchmarks
setup:
name: Get PR Info
runs-on: ubuntu-latest

permissions:
contents: read
pull-requests: write

outputs:
base_ref: ${{ steps.pr-info.outputs.base_ref }}
steps:
- name: Get PR base ref
id: pr-info
Expand All @@ -28,48 +32,102 @@
base_ref=$(gh pr view ${{ inputs.pr_number }} --repo ${{ github.repository }} --json baseRefName --jq .baseRefName)
echo "base_ref=$base_ref" >> $GITHUB_OUTPUT

bench-base:
name: Benchmark base branch
runs-on: ubuntu-latest
needs: setup
permissions: {}
outputs:
outcome: ${{ steps.bench.outcome }}
steps:
- name: Checkout base branch
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: ${{ needs.setup.outputs.base_ref }}
persist-credentials: false

- name: Set up Go
Comment thread
pjbgf marked this conversation as resolved.
Dismissed
uses: actions/setup-go@4b73464bb391d4059bd26b0524d20df3927bd417 # v6.3.0
with:
go-version: stable
cache-dependency-path: go.sum

- name: Run benchmarks
id: bench
run: go test -run='^$' -bench="$BENCH_FILTER" -benchmem -count=$BENCH_COUNT $BENCH_PATH > base.txt 2>&1
continue-on-error: true

- name: Upload results
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: base-bench
path: base.txt

bench-pr:
name: Benchmark PR branch
runs-on: ubuntu-latest
needs: setup
permissions: {}
outputs:
outcome: ${{ steps.bench.outcome }}
steps:
- name: Checkout PR branch
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: refs/pull/${{ inputs.pr_number }}/head
path: new
persist-credentials: false

- name: Checkout base branch
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up Go
uses: actions/setup-go@4b73464bb391d4059bd26b0524d20df3927bd417 # v6.3.0
with:
go-version: stable
cache-dependency-path: go.sum

- name: Run benchmarks
id: bench
run: go test -run='^$' -bench="$BENCH_FILTER" -benchmem -count=$BENCH_COUNT $BENCH_PATH > pr.txt 2>&1
continue-on-error: true

- name: Upload results
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
ref: ${{ steps.pr-info.outputs.base_ref }}
path: old
name: pr-bench
path: pr.txt

compare:
name: Compare and report
runs-on: ubuntu-latest
needs: [bench-base, bench-pr]
if: always()
permissions:
pull-requests: write
steps:
- name: Set up Go
uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 # v6.0.0
uses: actions/setup-go@4b73464bb391d4059bd26b0524d20df3927bd417 # v6.3.0
with:
go-version: stable
cache-dependency-path: new/go.sum

- name: Install benchstat
# renovate: datasource=go depName=golang.org/x/perf/cmd/benchstat
run: go install golang.org/x/perf/cmd/benchstat@v0.0.0-20260211190930-8161c38c6cdc

- name: Run base branch benchmarks
id: base-bench
working-directory: old
run: go test -run='^$' -bench=. -benchmem -count=1 ./test/... > ../base.txt 2>&1
continue-on-error: true
- name: Download base results
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
with:
name: base-bench

- name: Run PR branch benchmarks
id: pr-bench
working-directory: new
run: go test -run='^$' -bench=. -benchmem -count=1 ./test/... > ../pr.txt 2>&1
continue-on-error: true
- name: Download PR results
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
with:
name: pr-bench
Comment thread
pjbgf marked this conversation as resolved.

- name: Compare and report
if: always()
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ inputs.pr_number }}
REPO: ${{ github.repository }}
BASE_OUTCOME: ${{ steps.base-bench.outcome }}
PR_OUTCOME: ${{ steps.pr-bench.outcome }}
BASE_OUTCOME: ${{ needs.bench-base.outputs.outcome }}
PR_OUTCOME: ${{ needs.bench-pr.outputs.outcome }}
run: |
if [ "$BASE_OUTCOME" != "success" ] || [ "$PR_OUTCOME" != "success" ]; then
{
Expand Down
12 changes: 0 additions & 12 deletions test/bench_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,13 +123,6 @@ func benchCreate(filesystem billy.Filesystem, n string, nf func(billy.Filesystem
b.StopTimer()
err = f.Close()
require.NoError(b, err)

// Remove to avoid unbounded growth that would skew later iterations.
if filesystem != nil {
_ = filesystem.Remove(name)
} else {
_ = os.Remove(name)
}
b.StartTimer()
}
}
Expand Down Expand Up @@ -163,11 +156,6 @@ func benchWrite(filesystem billy.Filesystem, n string, nf func(billy.Filesystem,

b.StopTimer()
require.NoError(b, f.Close())
if filesystem != nil {
_ = filesystem.Remove(name)
} else {
_ = os.Remove(name)
}
b.StartTimer()
}
}
Expand Down