feat: add bench:cmp command to compare benchmark results between branches#268
Open
nigrosimone wants to merge 45 commits intodimdenGD:mainfrom
Open
feat: add bench:cmp command to compare benchmark results between branches#268nigrosimone wants to merge 45 commits intodimdenGD:mainfrom
nigrosimone wants to merge 45 commits intodimdenGD:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces a new CLI command
bench:cmpthat allows benchmarking and comparing the performance of two git branches.The goal is to make performance regressions or improvements immediately visible while developing or reviewing PRs.
Usage
Compare the current branch against the default branch (
main):Benchmark
my-branchagainstother-branch:If
bench:cmpis executed without parameters, an interactive mode is enabled. The CLI will prompt to select:What it does
At the end, it automatically switches back to the original branch.
Example output
the console show the improvements with colors
Bench scenarios
The
long stringbenchmark scenarios are currently included is defined in https://github.com/nigrosimone/ultimate-express/blob/pr-vs-master/bench/bench.js#L9 and https://github.com/nigrosimone/ultimate-express/blob/pr-vs-master/bench/server.js#L17 (we can add more)Why
This makes performance changes measurable and repeatable during development, instead of relying on intuition or ad-hoc testing. This also can help for understand if this my other PR #267 is good
It could be useful to add
bench:cmpas a GitHub Action on PRs.