Skip to content

feat(ci): add benchmark results as a comment to the PR for each run #810

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

Draft
Mossaka wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat(ci): add benchmark results as a comment to the PR for each run #810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c98735
feat(ci): add benchmark results as a comment to the PR for each run
Mossaka Jan 23, 2025
8261810
feat(ci): add the necessary pull-requests:write permission to comment…
Mossaka Jan 23, 2025
32abf45
fix(ci): changed benchmark action names to appropriate names
Mossaka Jan 28, 2025
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
6 changes: 5 additions & 1 deletion .github/actions/run-hey-load-test/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ runs:
summary-always: true
alert-threshold: "130%"
fail-on-alert: ${{ github.event_name == 'schedule' }}
# Enable comment to the PR
comment-always: ${{ github.event_name != 'schedule' }}

- name: Report Latency results
if : ${{ github.event_name == 'schedule' }}
uses: benchmark-action/[email protected]
Expand Down Expand Up @@ -66,4 +69,5 @@ runs:
summary-always: true
alert-threshold: "130%"
fail-on-alert: false
external-data-json-path: ./cache/latency_results.json
external-data-json-path: ./cache/latency_results.json
comment-always: true
10 changes: 8 additions & 2 deletions .github/workflows/benchmarks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ permissions:
deployments: write
# contents permission to update benchmark contents in gh-pages branch
contents: write
# pull requests permission to comment on PRs
pull-requests: write

jobs:
benchmark:
Expand Down Expand Up @@ -37,7 +39,7 @@ jobs:
- name: Store benchmark result
uses: benchmark-action/[email protected]
with:
name: Criterion.rs Benchmark
name: End-to-End Benchmark
tool: 'cargo'
output-file-path: output.txt
github-token: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -52,6 +54,8 @@ jobs:
# Automatically push the benchmark result to gh-pages branch
# See https://github.com/benchmark-action/github-action-benchmark?tab=readme-ov-file#charts-on-github-pages-1 for more details
auto-push: ${{ github.event_name == 'schedule' }}
# Enable comment to the PR
comment-always: ${{ github.event_name != 'schedule' }}

benchmark-mem:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -81,7 +85,7 @@ jobs:
- name: Store benchmark result
uses: benchmark-action/[email protected]
with:
name: Criterion.rs Benchmark
name: Memory Benchmark
tool: 'customSmallerIsBetter'
output-file-path: bench-mem.json
github-token: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -96,6 +100,8 @@ jobs:
# Automatically push the benchmark result to gh-pages branch
# See https://github.com/benchmark-action/github-action-benchmark?tab=readme-ov-file#charts-on-github-pages-1 for more details
auto-push: ${{ github.event_name == 'schedule' }}
# Enable comment to the PR
comment-always: ${{ github.event_name != 'schedule' }}

benchmark-http:
runs-on: ubuntu-latest
Expand Down
Loading