phpbench: added composer scripts for recording/comparing a baseline #38
Conversation
phpbench.json
Outdated
| @@ -1,3 +1,4 @@ | |||
| { | |||
| "bootstrap": "vendor/autoload.php" | |||
| "bootstrap": "vendor/autoload.php", | |||
| "xml_storage_path": "/tmp/.phpbench/storage" | |||
There was a problem hiding this comment.
with this line the baseline generated data is stored within the system temp dir.
that way we can easily checkout a different git branch without loosing data, which would otherwise be stored within the current repo folder
There was a problem hiding this comment.
I would keep this in <project root>.phpbench and add it to .gitignore if it's not already -- it's useful for various PHPBench artifacts.
There was a problem hiding this comment.
thx for your input! adjusted per feedback
| @@ -63,6 +63,8 @@ | |||
| "phpunit": "vendor/bin/phpunit", | |||
| "psalm": "vendor/bin/psalm", | |||
| "uptodocs": "docs/testdocs", | |||
| "benchmark-baseline": "phpbench run benchmarks --report=aggregate --tag=original --retry-threshold=5", | |||
There was a problem hiding this comment.
this script would generate a baseline and store its runtimes
| @@ -63,6 +63,8 @@ | |||
| "phpunit": "vendor/bin/phpunit", | |||
| "psalm": "vendor/bin/psalm", | |||
| "uptodocs": "docs/testdocs", | |||
| "benchmark-baseline": "phpbench run benchmarks --report=aggregate --tag=original --retry-threshold=5", | |||
| "benchmark-compare-baseline": "phpbench run benchmarks --report=aggregate --ref=original --retry-threshold=5", | |||
There was a problem hiding this comment.
after a baseline has been saved using composer benchmark-baseline one can then invoke composer benchmark-compare-baseline which then indicates relativ differences compared to the baselined performance scores
I am in the process of building a phpbench baseline compare feature as a github action workflow.
to get it running, we need this composer scripts merged into the main branch firsts.
could you please squash and merge this commits.
in the end the goal is to have a github annotation at pull request level which indicates the perf impact of a given PR like