Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added performance benchmarking doc #4169

Merged
merged 6 commits into from
Oct 4, 2023
Merged

Added performance benchmarking doc #4169

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6c9a840
docs: added performance benchmarking doc
martinkuba Sep 28, 2023
63a80d5
updated instructions for test:bench script
martinkuba Oct 3, 2023
d907681
Merge branch 'main' into benchmark-doc
martinkuba Oct 3, 2023
77620d0
updated cadence of automated runs
martinkuba Oct 3, 2023
dd24b7b
update broken links
martinkuba Oct 3, 2023
f44530e
Update doc/contributing/benchmark-tests.md
pichlermarc Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updated cadence of automated runs 
Co-authored-by: Tyler Benson <[email protected]>
  • Loading branch information
@martinkuba @tylerbenson
martinkuba and tylerbenson authored Oct 3, 2023
commit 77620d071a461994d4b0d83a2424ff96be547b48
2 changes: 1 addition & 1 deletion doc/contributing/benchmark-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ suite.run();

## Automatically running benchmark tests

If you want your test to run automatically with every release (to track trend over time), register the new test file by requiring it in `test/performance/benchmark/index.js`.
If you want your test to run automatically with every merge to main (to track trend over time), register the new test file by requiring it in `test/performance/benchmark/index.js`.

Add the `test:bench` script in package.json, if the module does not contain it already.

Expand Down