GraphQL API Protected branch #24640

parithiban · 2019-10-12T19:38:07Z

parithiban
Oct 12, 2019

I am using a GITHUB API V3 in one of my project now we are migrating to GraraphQL API V4. I want to list all the branches of the repo and i want to check wether it is protected branch. In GITHUB API V3 it has a branches api that will list all the branches along with it is protected key so it was each to check. Now in GraphQL i can get all the branches list but i can’t check wether the branch is protected or not.

refs(first: 100, refPrefix: "refs/heads/") {
        	nodes {
        		name
        	}
        }

Someone could assist on this how to proceed?

If that could not be achieved by the refs then is there a way to list all the protected branches alone

Regards

Parithiban

Answered by lee-dohm

Oct 23, 2019

You can use the following query to get the list of branch protection rules (and what branches they match) and the list of all branches for a repository:

{
  repository(owner: "atom", name: "atom") {
    branchProtectionRules(first: 100) {
      nodes {
        pattern
        matchingRefs(first: 100) {
          nodes {
            name
          }
        }
      }
    }
    refs(first: 100, refPrefix: "refs/heads/") {
      nodes {
        name
      }
    }
  }
}

I hope that helps! Let us know if you have more questions.

View full answer

lee-dohm · 2019-10-23T21:40:11Z

lee-dohm
Oct 23, 2019

You can use the following query to get the list of branch protection rules (and what branches they match) and the list of all branches for a repository:

{
  repository(owner: "atom", name: "atom") {
    branchProtectionRules(first: 100) {
      nodes {
        pattern
        matchingRefs(first: 100) {
          nodes {
            name
          }
        }
      }
    }
    refs(first: 100, refPrefix: "refs/heads/") {
      nodes {
        name
      }
    }
  }
}

I hope that helps! Let us know if you have more questions.

0 replies

maryamghani · 2020-04-16T17:53:28Z

maryamghani
Apr 16, 2020

Hello,

how can i use the same kind of pattern to protect my branch with wildcard rules like: release*

I am trying. to use API call for this

0 replies

parithiban · 2020-04-17T05:06:35Z

parithiban
Apr 17, 2020
Author

@maloochpich

See the below example to create a branch protection rule. You can change *pari* with release*

Screen Shot 2020-03-10 at 6 48 43 PM.png2852×810 205 KB

You can check the output in the settings tab and clicking branches options in your repo.

Screen Shot 2020-03-10 at 6.49.30 PM.png2752×1430 363 KB

0 replies

maryamghani · 2020-04-17T16:26:16Z

maryamghani
Apr 17, 2020

@parithiban thanks a lot that’s what I was looking for

0 replies

makeapp007 · 2020-04-17T20:26:33Z

makeapp007
Apr 17, 2020

Does github have api to see who can push to the protected branch? I am looking at pushAllowances but couldn’t figure it out.

The fix is to use fragment:

something like

pushAllowances(first: 50) {
          nodes {
            actor {
              ... on App {
                app_name: name
              }

0 replies

parithiban · 2020-04-22T06:45:17Z

parithiban
Apr 22, 2020
Author

@makeapp007

If I get your point correctly. You need to get the list of users who can push to the protected branch

You can follow the below steps:

Create a Branch protection rule in your repo. You need to set the branch protections to the user/team/app Reference

Screen Shot 2020-04-22 at 12.06.02 PM.png1458×666 70.8 KB

You can call the branch protection query for graphql to list out the user who has access to the protected branch.

Screen Shot 2020-04-22 at 12 00 14 PM.png2874×1408 331 KB

Hope this answers your query.

0 replies

maryamghani · 2020-05-04T20:31:45Z

maryamghani
May 4, 2020

@parithiban

question regarding to https://developer.github.com/v4/input_object/deletebranchprotectionruleinput/

what is the branchProtectionRuleId is?

I tried to add the repository node_id did not work,

any suggestion?

mutation {
    deleteBranchProtectionRule(input: {
        branchProtectionRuleId: "node_id"
    })
}

0 replies

parithiban · 2020-05-05T07:49:48Z

parithiban
May 5, 2020
Author

@maloochpich

First, you need to get the branch protection id then you can pass that to the mutation input parameter

To get the branch protection id see below

Screen_Shot_2020_05_05_at_1_11_59_PM.png2878×1504 346 KB

Then you need to pass that branch protection id.

mutation {
	deleteBranchProtectionRule(input: {
		branchProtectionRuleId: "YOUR_BRANCH_PROTECTION_ID"
	})
}

By applying the above query your branch protection will be deleted.

0 replies

maryamghani · 2020-09-30T19:28:58Z

maryamghani
Sep 30, 2020

how can we add user to the branch protection like this? @parithiban

Screen Shot 2020-09-30 at 9.28.34 PM1446×134 23.9 KB

0 replies

maryamghani · 2020-10-01T12:40:33Z

maryamghani
Oct 1, 2020

this is not working for me

0 replies

parithiban · 2020-10-02T14:16:38Z

parithiban
Oct 2, 2020
Author

@maloochpich

You can try with the following query

mutation{
  updateBranchProtectionRule(input:
    {
      branchProtectionRuleId:"YOUR_BRANCH_PROTECTION_ID",
      restrictsPushes:true,
      pushActorIds:["USER_ID","TEAM_ID"]
    }){    
  }
}

2 replies

grossmane Jun 29, 2023

Hi, @parithiban
I try to add pushActorIds or any other things like bypassPullRequestActorIds with graphQl, but I didn't have any success.
I found not much informations or posts for GitHub GraphQL, so I found this thread here.
maby you can help me:
here is my code:

fragment branchProtection on BranchProtectionRule {
  allowsDeletions
  allowsForcePushes
  creator {
    login
  }
  id
  blocksCreations
  isAdminEnforced
  requiresLinearHistory
  requiresConversationResolution
  requiredStatusCheckContexts
  requiredApprovingReviewCount
  requiresApprovingReviews
  requiresCodeOwnerReviews
  requiresStatusChecks
  restrictsPushes
  restrictsReviewDismissals
  dismissesStaleReviews
  pattern
}
mutation addBranchProtection(
  $repositoryId:                    ID!,
  $branchPattern:                   String!,
  $allowsDeletions:                 Boolean = false,
  $allowsForcePushes:               Boolean = false,
  $blocksCreations:                 Boolean = false,
  $dismissesStaleReviews:           Boolean = false,
  $isAdminEnforced:                 Boolean = true,
  $requiresLinearHistory:           Boolean = true,
  $requiresConversationResolution:  Boolean = false,
  $requiresApprovingReviews:        Boolean = false,
  $requiredApprovingReviewCount:    Int = 0,
  $requiresCodeOwnerReviews:        Boolean = false,
  $requiredStatusChecks:            [String!],
  $requiresStatusChecks:            Boolean = true,
  $restrictsReviewDismissals:       Boolean = false,
  $restrictsPushes:                 Boolean = false
) {
  createBranchProtectionRule(input: {
    repositoryId:                   $repositoryId
    pattern:                        $branchPattern
    allowsDeletions:                $allowsDeletions
    allowsForcePushes:              $allowsForcePushes
    blocksCreations:                $blocksCreations
    dismissesStaleReviews:          $dismissesStaleReviews
    isAdminEnforced:                $isAdminEnforced
    requiresLinearHistory:          $requiresLinearHistory
    requiresConversationResolution: $requiresConversationResolution
    requiresApprovingReviews:       $requiresApprovingReviews
    requiredApprovingReviewCount:   $requiredApprovingReviewCount
    pushActorIds:                   ["MYUSERID"]
    requiresCodeOwnerReviews:       $requiresCodeOwnerReviews
    requiredStatusCheckContexts:    $requiredStatusChecks
    requiresStatusChecks:           $requiresStatusChecks
    restrictsReviewDismissals:      $restrictsReviewDismissals
    restrictsPushes:                $restrictsPushes
  }) {
    branchProtectionRule {
      ...branchProtection
    }
  }
}

and the error is:

{
  "data": {
    "createBranchProtectionRule": null
  },
  "errors": [
    {
      "type": "NOT_FOUND",
      "path": [
        "createBranchProtectionRule"
      ],
      "locations": [
        {
          "line": 60,
          "column": 3
        }
      ],
      "message": "Could not resolve to a node with the global id of 'MYUSERID'"
    }
  ]
}

note: i replace my real userID with "MYUSERID" in code snippets.

I hope you can help me.
many thanks,
Jens

grossmane Jun 30, 2023

I found self the solution with the following code:

fragment branchProtection on BranchProtectionRule {
  pushAllowances(first:10) {
    nodes {
      id
    }
  }
  allowsDeletions
  allowsForcePushes
  creator {
    login
  }
  id
  blocksCreations
  isAdminEnforced
  requiresLinearHistory
  requiresConversationResolution
  requiredStatusCheckContexts
  requiredApprovingReviewCount
  bypassPullRequestAllowances(first:10) {
    nodes {
      id
    }
  }
  requiresApprovingReviews
  requiresCodeOwnerReviews
  requiresStatusChecks
  restrictsPushes
  restrictsReviewDismissals
  dismissesStaleReviews
  pattern
}

query getUser($login: String!) {
  user(login: $login) {
    id
  }
}

mutation addBranchProtection(
  $repositoryId:                    ID!,
  $branchPattern:                   String!,
  $pushActorIds:                    [ID!] = [],
  $allowsDeletions:                 Boolean = false,
  $allowsForcePushes:               Boolean = false,
  $blocksCreations:                 Boolean = false,
  $dismissesStaleReviews:           Boolean = false,
  $isAdminEnforced:                 Boolean = true,
  $requiresLinearHistory:           Boolean = true,
  $requiresConversationResolution:  Boolean = false,
  $requiresApprovingReviews:        Boolean = false,
  $requiredApprovingReviewCount:    Int = 0,
  $bypassPullRequestActorIds:       [ID!] = [],
  $requiresCodeOwnerReviews:        Boolean = false,
  $requiredStatusChecks:            [String!],
  $requiresStatusChecks:            Boolean = true,
  $restrictsReviewDismissals:       Boolean = false,
  $restrictsPushes:                 Boolean = false
) {
  createBranchProtectionRule(input: {
    repositoryId:                   $repositoryId
    pattern:                        $branchPattern
    pushActorIds:                   $pushActorIds
    allowsDeletions:                $allowsDeletions
    allowsForcePushes:              $allowsForcePushes
    blocksCreations:                $blocksCreations
    dismissesStaleReviews:          $dismissesStaleReviews
    isAdminEnforced:                $isAdminEnforced
    requiresLinearHistory:          $requiresLinearHistory
    requiresConversationResolution: $requiresConversationResolution
    requiresApprovingReviews:       $requiresApprovingReviews
    requiredApprovingReviewCount:   $requiredApprovingReviewCount
    bypassPullRequestActorIds:      $bypassPullRequestActorIds
    requiresCodeOwnerReviews:       $requiresCodeOwnerReviews
    requiredStatusCheckContexts:    $requiredStatusChecks
    requiresStatusChecks:           $requiresStatusChecks
    restrictsReviewDismissals:      $restrictsReviewDismissals
    restrictsPushes:                $restrictsPushes
  }) {
    branchProtectionRule {
      ...branchProtection
    }
  }
}

as first request, I get the node ID of the user getUser() and then I request the addBranchProtection()

maryamghani · 2020-10-03T14:14:33Z

maryamghani
Oct 3, 2020

parithiban:

mutation{
  updateBranchProtectionRule(input:
    {
      branchProtectionRuleId:"YOUR_BRANCH_PROTECTION_ID",
      restrictsPushes:true,
      pushActorIds:["USER_ID","TEAM_ID"]
    }){    
  }
}

@parithiban this does not work

mutation{
  updateBranchProtectionRule(input:
    {
      branchProtectionRuleId:"",
      restrictsPushes:true,
      pushActorIds:[""]
    }){    
        branchProtectionRule{
            branchProtectionRuleId
            restrictsPushes
        }
  }
}

{
    "errors": [
        {
            "path": [
                "mutation",
                "updateBranchProtectionRule",
                "branchProtectionRule",
                "branchProtectionRuleId"
            ],
            "extensions": {
                "code": "undefinedField",
                "typeName": "BranchProtectionRule",
                "fieldName": "branchProtectionRuleId"
            },
            "locations": [
                {
                    "line": 9,
                    "column": 13
                }
            ],
            "message": "Field 'branchProtectionRuleId' doesn't exist on type 'BranchProtectionRule'"
        }
    ]
}

0 replies

parithiban · 2020-10-15T14:52:17Z

parithiban
Oct 15, 2020
Author

@maloochpich

You need to slightly modify your query

mutation{
 updateBranchProtectionRule(input:
   {
     branchProtectionRuleId:"",
     restrictsPushes:true,
     pushActorIds:[""]
   }){    
       branchProtectionRule{
           id
           restrictsPushes
       }
 }
}

branchProtectionRule node has id paramaeter and not branchProtectionRuleId

0 replies

maryamghani · 2020-11-10T10:56:23Z

maryamghani
Nov 10, 2020

This worked @parithiban Thanks

0 replies

maryamghani · 2020-11-10T12:35:38Z

maryamghani
Nov 10, 2020

@parithiban by running this i get this error:

"message": "Field must have selections (field 'deleteBranchProtectionRule' returns DeleteBranchProtectionRulePayload but has no selections. Did you mean 'deleteBranchProtectionRule { ... }'?)"

0 replies

parithiban · 2020-11-18T08:10:27Z

parithiban
Nov 18, 2020
Author

@maloochpich

What is the mutation query that you are trying to execute?

0 replies

maryamghani · 2020-11-18T12:36:35Z

maryamghani
Nov 18, 2020

@parithiban

mutation {
	deleteBranchProtectionRule(input: {
		branchProtectionRuleId: ""
	})
}

this is what i run

0 replies

parithiban · 2020-11-20T08:05:00Z

parithiban
Nov 20, 2020
Author

@maloochpich

As the error suggests it should have a selection of subfields. Can you try with the below query?

mutation {
   deleteBranchProtectionRule(input: {
   	branchProtectionRuleId: "XXXX-XXXX-XXXX"
 }){
   clientMutationId
 }
}

0 replies

maryamghani · 2020-12-09T20:22:24Z

maryamghani
Dec 9, 2020

that is working thanks a lot for your help and being so helpful as always

0 replies

navachaitanyak · 2023-07-27T14:27:26Z

navachaitanyak
Jul 27, 2023

can someone help to get the branch protection rule id for one of the rules like, I have branch protection rule 'test*' and I want to get the branch protection rule id for this one, can someone help me, please

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

GraphQL API Protected branch #24640

{{title}}

Replies: 20 comments 2 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

GraphQL API Protected branch #24640

Replies: 20 comments · 2 replies

parithiban Apr 17, 2020 Author

parithiban Apr 22, 2020 Author

parithiban May 5, 2020 Author

parithiban Oct 2, 2020 Author

parithiban Oct 15, 2020 Author

parithiban Nov 18, 2020 Author

parithiban Nov 20, 2020 Author

Replies: 20 comments 2 replies

parithiban
Apr 17, 2020
Author

parithiban
Apr 22, 2020
Author

parithiban
May 5, 2020
Author

parithiban
Oct 2, 2020
Author

parithiban
Oct 15, 2020
Author

parithiban
Nov 18, 2020
Author

parithiban
Nov 20, 2020
Author