astro/benchmark/bench/README.md
Bjorn Lu f4937949d6
Refactor benchmark script (#6376)
* Add timer setting

* Setup benchmark code

* Setup memory benchmark

* Add compare function

* Add result preview

* Setup results preview

* Simplify script for CI

* Update CI

* Cleanup

* Temp remove fork guard

* Fix stuff

* Fix again

* Fix quotes

* Fix multiline output

* Simplify title

* Fix memory numbers

* Remove astro bin dir

* Fix gc

* Add repo guards

* Fix wrong call

* Set max space size

* Remove guard

* Bump memory a bit

* Organize neatly

* Update readme

* Try large md

* Try no gc

* Revert markdown and gc changes

* Test sha

* Try ref

* Try 128mb

* Set 256

* Add guard

* Apply suggestions from code review

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

* Add docs comment

---------

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2023-03-01 08:46:06 +00:00

569 B

bench

This bench folder contains different benchmarking files that you can run via astro-benchmark <bench-file-name>, e.g. astro-benchmark memory. Files that start with an underscore are not benchmarking files.

Benchmarking files will run against a project to measure its performance, and write the results down as JSON in the results folder. The results folder is gitignored and its result files can be safely deleted if you're not using them.

You can duplicate _template.js to start a new benchmark test. All shared utilities are kept in _util.js.