summaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorGravatar Matthew Phillips <matthew@matthewphillips.info> 2021-05-26 11:31:53 -0400
committerGravatar GitHub <noreply@github.com> 2021-05-26 11:31:53 -0400
commitda47225efe5cc65cdc0e340f998a8dfbcc45771e (patch)
treedc01ddf04be0cc2a1db2f31d0f3e9910ce575b0a /contributing.md
parent8a375e66d27042fe51e6d4217416962d444fad28 (diff)
downloadastro-da47225efe5cc65cdc0e340f998a8dfbcc45771e.tar.gz
astro-da47225efe5cc65cdc0e340f998a8dfbcc45771e.tar.zst
astro-da47225efe5cc65cdc0e340f998a8dfbcc45771e.zip
Add benchmarking for dev and build (#240)
* Add benchmarking for the dev server This adds benchmarking for the dev server. * Use fs.rm instead * Only rimraf if the folder exists * Make uncached match CI * Change the cached time too * Don't run benchmark in CI * Switch back test command * Make tests be within 10 percent * Use yarn to run multiple things * Turn benchmark into uvu tests * Debugging benchmark * Print chunk for testing * Ignore benchmark folder in uvu * Add build benchmarking * Update benchmark numbers
Diffstat (limited to '')
-rw-r--r--contributing.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
index dda573d33..5d0e9324b 100644
--- a/contributing.md
+++ b/contributing.md
@@ -38,3 +38,22 @@ Commit and push these changes, then run an npm publish for each of the packages
cd packages/astro
npm publish
```
+
+## Running benchmarks
+
+We have benchmarks to keep performance under control. You can run these by running (from the project root):
+
+```shell
+yarn workspace astro run benchmark
+```
+
+Which will fail if the performance has regressed by __10%__ or more.
+
+To update the times cd into the `packages/astro` folder and run the following:
+
+```shell
+node test/benchmark/build.bench.js --save
+node test/benchmark/dev.bench.js --save
+```
+
+Which will update the build and dev benchmarks. \ No newline at end of file