Get if pull request passed all required status checks using GitHub API

Question

I need to check via GitHub API if a pull request passed all required status checks. I use GitHub Enterprise 2.8 at this moment.

I know that I can get all status checks for last commit (following statuses_url in pull request). However, I don't know which status checks are set up to be required in a given repository. This is my main problem.

I also need to aggregate these status checks, group them by context and take latest in each context. It's ok, but seems to be reimplementation of logic, that GitHub performs internally when decides if a pull request can be merged.

For my case, it would be ideal to have something like can_be_merged in pull request fields, which meaning is mergeable && all required status checks passed && approved, but as far as I know there is no such field.

did you ever figure this out? I was about to post almost the same question. I've been pouring over the docs to figure this out, to no avail... — moustachio, Jun 23 '19 at 12:32
Nope, I've ended up hardcoding required status checks in my app :( — algebraic, Jun 24 '19 at 08:02

score 5 · Answer 1 · answered Jul 04 '19 at 19:32

5

Finally solved this! You actually need to get the information off the protected branch, not off the check itself. Here are some API details: https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch.

So the flow to solve this is:

Check if the base branch for the PR is protected, and if so;
Use the above endpoint to determine which checks are required;
Compare the checks on the latest PR commit to the required checks determined in step 2.

answered Jul 04 '19 at 19:32

moustachio

2,924
3
36
68

I have a slight variation of this: I want to get the required checks _which are GitHub Actions_ and this seems to complicate things a lot: https://stackoverflow.com/questions/75063703/github-api-find-status-of-required-checks-on-a-pull-request-towards-protected-b – jakub.g Jan 09 '23 at 22:47

score 0 · Answer 2 · answered Oct 07 '21 at 12:58

Based on @moustachio's answer, if you are using v4 graphql API, you may use

    pullRequest(...) {
      baseRef {
        refUpdateRule {
          requiredStatusCheckContexts
        }
      }
    }

to get the same info without additional API request

Get if pull request passed all required status checks using GitHub API

2 Answers2

Linked