Get the right SHA for the snapshot depending on the event type #42
Conversation
This file contains 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
febuiles
approved these changes
Mar 16, 2023
elireisman
reviewed
Mar 16, 2023
| * See https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request for more details | ||
| * about why this function is necessary, but the short reason is that GITHUB_SHA is _not_ necessarily the head sha | ||
| * of the PR when the event is pull_request (or some other related event types). | ||
| * |
There was a problem hiding this comment.
☝️ This is such a gotcha for folks building DG snapshot Actions I'm glad to see us call it out in the toolkit code here! ❤️
🤔 I wonder what else we could do to document the "so you're building a DG snapshot Action" gotchas somewhere public for folks that don't choose to use the toolkit under the hood? Maybe a blog post about the quirk?
There was a problem hiding this comment.
Yeah, I was thinking about sneaking something about this into the API docs, since I think that's all we really have now!
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
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.
As noted in the Actions docs,
context.shacan represent different things in different event types. In apull_requestevent, it happens not to be the sha of the head commit for some reason. Instead, in those cases you're meant to get the head sha from the pull_request payload.This PR introduces a helper function,
shaFromContext, that matches on the event type and gets the correct sha for the snapshot. I've also taken the liberty of doing a few quick test refactors.For prior art, see: