Skip to content

Commit e3de4ae

Browse files
Copilothsluoyz
andcommitted
Add documentation comments to benchmark workflow
Co-authored-by: hsluoyz <3787410+hsluoyz@users.noreply.github.com>
1 parent e262e64 commit e3de4ae

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

.github/workflows/benchmark.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
# Performance Benchmark CI Workflow
2+
#
3+
# This workflow automatically runs performance benchmarks on pull requests
4+
# and posts a comparison comment showing speed differences between the PR
5+
# and the base branch (master).
6+
#
7+
# The workflow:
8+
# 1. Runs benchmarks on the PR branch
9+
# 2. Runs benchmarks on the base branch (master)
10+
# 3. Compares the results and identifies performance regressions/improvements
11+
# 4. Posts a detailed comparison table as a PR comment
12+
#
13+
# Performance changes > 10% are flagged as significant to help maintainers
14+
# catch performance regressions before merging.
15+
116
name: Performance Benchmark
217

318
on:

0 commit comments

Comments
 (0)