Skip to content

Commit ec06262

Browse files
authored
feat(patch): Update documentation - add Vapor CI workflows and examples (#315)
Add nice CI example from Vapor.
1 parent bfed2db commit ec06262

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Sources/Benchmark/Documentation.docc/ComparingBenchmarksCI.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,13 @@ swift package benchmark thresholds read
5454
- 2: Regressions detected
5555
- 4: Only improvements detected
5656

57+
### Example GitHub CI Workflow from Vapor
58+
59+
Vapor have a nice example [for CI integration at GitHub](https://github.com/vapor/ci/blob/main/.github/workflows/run-benchmark.yml) which
60+
can [be manually run like this](https://github.com/vapor/multipart-kit/blob/main/.github/workflows/benchmark.yml).
61+
62+
Sample output [can be found here](https://github.com/vapor/multipart-kit/pull/107#issuecomment-2629492189).
63+
5764
### Example: GitHub CI Workflow for Baseline Comparison
5865

5966
This workflow compares any pull request against the `main` branch, failing on regression. If the comparison is equal or favorable, it comments on the pull request with the results.

0 commit comments

Comments
 (0)