github-action-benchmark
github-action-benchmark copied to clipboard
New feature: Supplement historic benchmark results manually
If you have started to collect benchmark results at a certain stage of your project, previously there was no simple way to compare your current benchmarks to these historic results. To close this gap, this PR adds a new script, run_local.ts
, which allows to easily check in historic results into the gh-pages
branch. In write.ts
, a new optional parameter insert_mode
is created that makes sure historic benches are inserted at the right point in time. This patch also adds a section to the docs that explains the motivation and usage of the new script.
Usage:
GITHUB_REPOSITORY=<owner>/<repo> node /path/to/github-action-benchmark/dist/src/index_local.js /path/to/config.yml <commit-sha>
Example commit (it actually works!): https://github.com/LinqLover/squeak-tracedebugger/commit/75815252aba86393761e76d136d67f973f1cd6df & https://github.com/LinqLover/squeak-tracedebugger/commit/afc45a3039c3299a729a7358fe1c4d4e4919fc44#commitcomment-63175903
I am looking very forward to your review! I understand that this is a rather unusual feature for a GitHub action, but I hope you can understand my motivation for it and share my belief that other new users of this helpful action might be in a similar need. If you think that this enhancement does not fit into the scope of this repository, I could also upload my sources anywhere else, but of course, this would complicate dependency management and maintenance, so it would be my last resort only. Have a nice weekend! :-)
hi @LinqLover
Thank you for the idea and your contribution! I like the idea in general but I need to think about it. I'll get back to you soon :)
I noticed that you removed a lot from package-lock.json
file. Could you please run npm install
with node v16? You've modified the package-lock.json
file back to an old format so I'm assuming you're using a lower version of node.
Thank you for your feedback! 🙂 I will correct the lock file later today, I was assuming node 12 because this version is specified in the action.yml
. Maybe this should be updated?