When running on a schedule, make a better guess about whether we're analyzing the default branch. - #1211
Merged
chrisgavin merged 1 commit intoAug 25, 2022
Merged
When running on a schedule, make a better guess about whether we're analyzing the default branch.#1211chrisgavin merged 1 commit into
chrisgavin merged 1 commit into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
…nalyzing the default branch.
chrisgavin
marked this pull request as ready for review
August 25, 2022 11:30
edoardopirovano
approved these changes
Aug 25, 2022
edoardopirovano
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Thanks for finding and fixing!
Sorry, something went wrong.
aeisenberg
reviewed
Aug 25, 2022
Comment thread
src/actions-util.ts
Comment on lines
+877
to
+879
| if (process.env.GITHUB_EVENT_NAME === "schedule") { | ||
| defaultBranch = removeRefsHeadsPrefix(getRequiredEnvParam("GITHUB_REF")); | ||
| } |
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
A bit late on this, but aren't we guaranteed to be running on the default branch if we are in a scheduled run?
if (process.env.GITHUB_EVENT_NAME === "schedule") {
return true;
}
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
There was a problem hiding this comment.
No, because you can always check out and analyze whatever you want. e.g. you could analyze all your release branches.
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Good point!
Sorry, something went wrong.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
3 participants
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.
When running on a schedule, the event payload does not contain any repository information such as the default branch name. This means we incorrectly say that we're not analyzing the default branch when we actually are.
Fortunately we know that when running on a schedule the event is triggered against the default branch, hence the default branch is in GITHUB_REF.
Note it's not quite sufficient to assume that just because the event was schedule we're analyzing the default branch though. The user may have configured the workflow to check out and analyze a different branch. Therefore we cannot just always return true when we're running on a schedule, we do have to still compare GITHUB_REF against any user-provided ref input.
Merge / deployment checklist