Skip to content

Commit 140c98b

Browse files
joyeecheungMylesBorins
authored andcommitted
doc: document the benchmark CI
PR-URL: #16086 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
1 parent 0e707f3 commit 140c98b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/guides/writing-and-running-benchmarks.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* [Running all benchmarks](#running-all-benchmarks)
1111
* [Comparing Node.js versions](#comparing-nodejs-versions)
1212
* [Comparing parameters](#comparing-parameters)
13+
* [Running Benchmarks on the CI](#running-benchmarks-on-the-ci)
1314
* [Creating a benchmark](#creating-a-benchmark)
1415
* [Basics of a benchmark](#basics-of-a-benchmark)
1516
* [Creating an HTTP benchmark](#creating-an-http-benchmark)
@@ -298,6 +299,11 @@ chunk encoding mean confidence.interval
298299

299300
![compare tool boxplot](doc_img/scatter-plot.png)
300301

302+
### Running Benchmarks on the CI
303+
304+
To see the performance impact of a Pull Request by running benchmarks on
305+
the CI, check out [How to: Running core benchmarks on Node.js CI][benchmark-ci].
306+
301307
## Creating a benchmark
302308

303309
### Basics of a benchmark
@@ -432,3 +438,4 @@ Supported options keys are:
432438
[t-test]: https://en.wikipedia.org/wiki/Student%27s_t-test#Equal_or_unequal_sample_sizes.2C_unequal_variances
433439
[git-for-windows]: http://git-scm.com/download/win
434440
[nghttp2.org]: http://nghttp2.org
441+
[benchmark-ci]: https://github.com/nodejs/benchmarking/blob/master/docs/core_benchmarks.md

0 commit comments

Comments
 (0)