When running on a schedule, make a better guess about whether we're analyzing the default branch.

[chrisgavin]

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

• Confirm this change is backwards compatible with existing workflows.
• Confirm the readme has been updated if necessary.
• Confirm the changelog has been updated if necessary. (I'm assuming the changelog does not need to be updated, as this mostly only affects an feature that's not fully shipped yet, but let me know if you disagree.)

[edoardopirovano]

Thanks for finding and fixing!

[aeisenberg]

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;
  }

[chrisgavin]

No, because you can always check out and analyze whatever you want. e.g. you could analyze all your release branches.

[aeisenberg]

Good point!