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.

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

New feature: Supplement historic benchmark results manually #99

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

LinqLover
Copy link

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!): hpi-swa-lab/squeak-tracedebugger@7581525 & hpi-swa-lab/squeak-tracedebugger@afc45a3#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! :-)

If you have started to collect benchmark results at a certain stage of your project but now also would like to compare these results to older historic values, the `run_local` file can be run to check in these historic data.

This patch also adds a section to the docs that explains the new script.
LinqLover added a commit to hpi-swa-lab/squeak-tracedebugger that referenced this pull request Jan 9, 2022
@ktrz
Copy link
Member

ktrz commented Jan 13, 2022

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.

@LinqLover
Copy link
Author

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants