github-action-benchmark
github-action-benchmark copied to clipboard
benchmark-action
Add optional commit SHA in config.
Description
Allows the user to pass in a commit SHA to use instead of relying on the payload or head commit. The main use-case of this is for workflow dispatch runs where the SHA is provided through an input.
This change should be valid based on https://docs.github.com/en/rest/reference/commits#get-a-commit.
Hi @jefchien
Thank you for your contribution! Could you please explain to me a bit more why would we want to provide the SHA as an input rather than just using the one provided via pull request or fall back to the current commit's sha?
Hi @ktrz,
So, in my use case, the workflow where the action is used can be triggered by a workflow dispatch where the SHA is provided as an input. This allows us to run the benchmarking after successful CI workflow runs or on selected commits. The issue I've found is that the github.context.ref used in the fall back is the workflow commit SHA rather than the one actually used in the benchmarking. If there's another way to access the workflow dispatch inputs, it might be a better solution. This PR provides an optional field that will supersede any of the other attempts.
@jefchien
Is running the workflow_dispatch job event an automated process? Instead of providing the commit_sha as input, would you be able to push a branch or tag and run the workflow from there instead?
That way you can make the branch point to the commit you want, and run the workflow from that branch, so that the commit is correct and you don't need to provide the commit_sha as input.
It might be more tricky if your invocation of the workflow_dispatch job is automated (because you'd need a GitHub account to publish it from I guess) so that's why I ask.
@NathanielRN
Running the workflow_dispatch is a manual process, but the same workflow is also triggered by a repository_dispatch from a different workflow. That's an interesting workaround. I suppose I could use a GitHub action like https://github.com/marketplace/actions/create-branch to create the branch as part of the workflow and then checkout that branch in the job used to run this action. Actually, that probably won't work since the GitHub context is based on the workflow run.
