Strict status checks setting not being properly reported by GraphQL API #59471

terrabitz · 2023-06-27T19:32:54Z

terrabitz
Jun 27, 2023

Select Topic Area

Bug

Body

When making calls against the v4 API, the requiresStrictStatusChecks property (repository.branchProtectionRules.edges.node.requiresStrictStatusChecks) is always being reported as true regardless of whether the setting is actually toggled or not.

The following example uses the repository terrabitz/QuackTest. The master branch as strict status checks enabled, while the develop branch does not.

Example v4 API query:

{
  repository(name: "QuackTest", owner: "terrabitz") {
    branchProtectionRules(first: 10) {
      edges {
        node {
          pattern
          requiresStrictStatusChecks
        }
      }
    }
  }
}

Results:

{
  "data": {
    "repository": {
      "branchProtectionRules": {
        "edges": [
          {
            "node": {
              "pattern": "master",
              "requiresStrictStatusChecks": true
            }
          },
          {
            "node": {
              "pattern": "develop",
              "requiresStrictStatusChecks": true
            }
          }
        ]
      }
    }
  }
}

The v3 API correctly indicates that the strict status checks are enabled for master but not for develop

> gh api -H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28" /repos/terrabitz/QuackTest/branches/master/protection/required_status_checks | jq

{
  "url": "https://api.github.com/repos/terrabitz/QuackTest/branches/master/protection/required_status_checks",
  "strict": true,
  "contexts": [],
  "contexts_url": "https://api.github.com/repos/terrabitz/QuackTest/branches/master/protection/required_status_checks/contexts",
  "checks": []
}

> gh api -H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28" /repos/terrabitz/QuackTest/branches/develop/protection/required_status_checks | jq

{
  "message": "Required status checks not enabled",
  "documentation_url": "https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection"
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

Strict status checks setting not being properly reported by GraphQL API #59471

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

GitHub Community

Strict status checks setting not being properly reported by GraphQL API #59471

Uh oh!

Uh oh!

terrabitz Jun 27, 2023

Select Topic Area

Body

Replies: 0 comments

terrabitz
Jun 27, 2023