Update a branch protection rule
Arguments
UpdateBranchProtectionRuleInput [input]
Autogenerated input type of UpdateBranchProtectionRule
Attributes
Can this branch be deleted.
Are force pushes allowed on this branch.
Is branch creation a protected operation.
The global relay id of the branch protection rule to be updated.
A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.
A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.
A unique identifier for the client performing the mutation.
Will new commits pushed to matching branches dismiss pull request review approvals.
Can admins override branch protection.
Whether users can pull changes from upstream when the branch is locked. Set totrue
to allow fork syncing. Set to false
to prevent fork syncing.
Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
The glob-like pattern used to determine matching branches.
A list of User, Team, or App IDs allowed to push to matching branches.
Whether the most recent push must be approved by someone other than the person who pushed it
Number of approving reviews required to update matching branches.
The list of required deployment environments
List of required status check contexts that must pass for commits to be accepted to matching branches.
The list of required status checks
Are approving reviews required to update matching branches.
Are reviews from code owners required to update matching branches.
Are commits required to be signed.
Are conversations required to be resolved before merging.
Are successful deployments required before merging.
Are merge commits prohibited from being pushed to this branch.
Are status checks required to update matching branches.
Are branches required to be up to date before merging.
Is pushing to matching branches restricted.
Is dismissal of pull request reviews restricted.
A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.
Parameters for UpdateBranchProtectionRule
Returns
UpdateBranchProtectionRulePayload [object]
Autogenerated return type of UpdateBranchProtectionRule
Attributes
The newly created BranchProtectionRule.
A unique identifier for the client performing the mutation.