CreateBranchProtectionRuleInput

Input Object

allowsDeletions

Can this branch be deleted.

allowsForcePushes

Are force pushes allowed on this branch.

blocksCreations

Is branch creation a protected operation.

bypassForcePushActorIds

A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.

bypassPullRequestActorIds

A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.

clientMutationId

A unique identifier for the client performing the mutation.

dismissesStaleReviews

Will new commits pushed to matching branches dismiss pull request review approvals.

isAdminEnforced

Can admins override branch protection.

lockAllowsFetchAndMerge

Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing.

lockBranch

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

pattern

The glob-like pattern used to determine matching branches.

pushActorIds

A list of User, Team, or App IDs allowed to push to matching branches.

repositoryId

The global relay id of the repository in which a new branch protection rule should be created in.

requireLastPushApproval

Whether the most recent push must be approved by someone other than the person who pushed it

requiredApprovingReviewCount

Number of approving reviews required to update matching branches.

requiredDeploymentEnvironments

The list of required deployment environments

requiredStatusCheckContexts

List of required status check contexts that must pass for commits to be accepted to matching branches.

requiredStatusChecks

The list of required status checks

requiresApprovingReviews

Are approving reviews required to update matching branches.

requiresCodeOwnerReviews

Are reviews from code owners required to update matching branches.

requiresCommitSignatures

Are commits required to be signed.

requiresConversationResolution

Are conversations required to be resolved before merging.

requiresDeployments

Are successful deployments required before merging.

requiresLinearHistory

Are merge commits prohibited from being pushed to this branch.

requiresStatusChecks

Are status checks required to update matching branches.

requiresStrictStatusChecks

Are branches required to be up to date before merging.

restrictsPushes

Is pushing to matching branches restricted.

restrictsReviewDismissals

Is dismissal of pull request reviews restricted.

reviewDismissalActorIds

A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.