Skip to content

Commit 5e95e75

Browse files
authored
Simplify benchmark comments (#8581)
## Rational for this change #8465 made the SQL benchmarks comments and titles unnecessarily verbose, I was too excited to merge it to just get a quicker feedback loop. ## What changes are included in this PR? Restores how SQL benchmarks comments are displayed - one per benchmark, regardless of what workflow ran it. ## What APIs are changed? Are there any user-facing changes? N/A Signed-off-by: Adam Gutglick <adam@spiraldb.com>
1 parent e2478aa commit 5e95e75

1 file changed

Lines changed: 5 additions & 11 deletions

File tree

.github/workflows/sql-benchmarks.yml

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -675,14 +675,9 @@ jobs:
675675
python3 scripts/s3-download.py s3://vortex-ci-benchmark-results/data.json.gz data.json.gz --no-sign-request
676676
gzip -d -c data.json.gz > base.json
677677
678-
benchmark_name="${{ matrix.name }}"
679-
if [ "${{ inputs.benchmark_profile }}" != "full" ]; then
680-
benchmark_name="$benchmark_name (${{ inputs.benchmark_profile }})"
681-
fi
682-
683-
echo "# Benchmarks: $benchmark_name" > comment.md
678+
echo "# Benchmarks: ${{ matrix.name }}" > comment.md
684679
echo '' >> comment.md
685-
uv run --no-project scripts/compare-benchmark-jsons.py base.json results.json "$benchmark_name" \
680+
uv run --no-project scripts/compare-benchmark-jsons.py base.json results.json "${{ matrix.name }}" \
686681
>> comment.md
687682
cat comment.md >> "$GITHUB_STEP_SUMMARY"
688683
@@ -692,9 +687,8 @@ jobs:
692687
with:
693688
file-path: comment.md
694689
# There is exactly one comment per comment-tag. If a comment with this tag already exists,
695-
# this action will *update* the comment instead of posting a new comment. Therefore, each
696-
# unique benchmark configuration must have a unique comment-tag.
697-
comment-tag: bench-pr-comment-${{ matrix.id }}${{ inputs.benchmark_profile == 'base' && '-base' || '' }}
690+
# this action will *update* the comment instead of posting a new comment.
691+
comment-tag: bench-pr-comment-${{ matrix.id }}
698692

699693
- name: Comment PR on failure
700694
if: failure() && inputs.mode == 'pr' && github.event.pull_request.head.repo.fork == false
@@ -704,7 +698,7 @@ jobs:
704698
# 🚨🚨🚨❌❌❌ SQL BENCHMARK FAILED ❌❌❌🚨🚨🚨
705699
706700
Benchmark `${{ matrix.name }}` (${{ inputs.benchmark_profile }}) failed! Check the [workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) for details.
707-
comment-tag: bench-pr-comment-${{ matrix.id }}${{ inputs.benchmark_profile == 'base' && '-base' || '' }}
701+
comment-tag: bench-pr-comment-${{ matrix.id }}
708702

709703
- name: Upload Benchmark Results
710704
if: inputs.mode == 'develop'

0 commit comments

Comments
 (0)