Skip to content

[CI][Bench] Add compare option to manual bench runs #1222

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
merged 1 commit into from
Mar 25, 2025
Merged

[CI][Bench] Add compare option to manual bench runs #1222

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
8 changes: 8 additions & 0 deletions .github/workflows/benchmarks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ on:
type: string
required: false
default: ''
bench_script_compare:
description: Compare label, passed to script executing benchmark as '--compare <label>'
type: choice
required: false
default: 'Baseline_PVC'
options:
- 'Baseline_PVC'
runner:
description: Runner
type: choice
Expand All @@ -32,4 +39,5 @@ jobs:
with:
pr_no: ${{ inputs.pr_no }}
bench_script_params: ${{ inputs.bench_script_params }}
bench_script_compare: ${{ inputs.bench_script_compare }}
runner: ${{ inputs.runner }}
20 changes: 17 additions & 3 deletions .github/workflows/reusable_benchmarks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ on:
required: false
type: string
default: ''
bench_script_compare:
required: false
type: string
default: ''
runner:
required: false
type: string
Expand All @@ -35,14 +39,24 @@ jobs:
runs-on: ${{ inputs.runner }}

steps:
- name: Establish bench params
run: |
params="${{ inputs.bench_script_params }}"
if [ -n "${{ inputs.bench_script_compare }}" ]; then
params="$params --compare '${{ inputs.bench_script_compare }}'"
fi

echo "params=$params"
echo "bench_params=$params" >> $GITHUB_ENV

- name: Add comment to PR
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
if: ${{ always() && inputs.pr_no != 0 }}
with:
script: |
const pr_no = '${{ inputs.pr_no }}';
const url = '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}';
const params = '${{ inputs.bench_script_params }}';
const params = '${{ env.bench_params }}';
const body = `Compute Benchmarks run (with params: ${params}):\n${url}`;

github.rest.issues.createComment({
Expand Down Expand Up @@ -145,7 +159,7 @@ jobs:
--output-html remote
--results-dir ${{ github.workspace }}/results-repo
--output-markdown
${{ inputs.bench_script_params }}
${{ env.bench_params }}

# In case it failed to add a comment, we can still print the results.
- name: Print benchmark results
Expand All @@ -168,7 +182,7 @@ jobs:
const url = '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}';
const test_status = '${{ steps.benchmarks.outcome }}';
const job_status = '${{ job.status }}';
const params = '${{ inputs.bench_script_params }}';
const params = '${{ env.bench_params }}';
const body = `Compute Benchmarks run (${params}):\n${url}\nJob status: ${job_status}. Test status: ${test_status}.\n ${markdown}`;

github.rest.issues.createComment({
Expand Down
Loading