BranchProtectionRule

Object

allowsDeletions

Can this branch be deleted.

allowsForcePushes

Are force pushes allowed on this branch.

blocksCreations

Is branch creation a protected operation.

branchProtectionRuleConflicts

A list of conflicts matching branches protection rule and other branch protection rules

bypassForcePushAllowances

A list of actors able to force push for this branch protection rule.

bypassPullRequestAllowances

A list of actors able to bypass PRs for this branch protection rule.

creator

The actor who created this branch protection rule.

databaseId

Identifies the primary key from the database.

dismissesStaleReviews

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

id

The Node ID of the BranchProtectionRule object

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.

matchingRefs

Repository refs that are protected by this rule

pattern

Identifies the protection rule pattern.

pushAllowances

A list push allowances for this branch protection rule.

repository

The repository associated with this branch protection rule.

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

List of required deployment environments that must be deployed successfully to update matching branches

requiredStatusCheckContexts

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

requiredStatusChecks

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

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

Does this branch require deployment to specific environments 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.

reviewDismissalAllowances

A list review dismissal allowances for this branch protection rule.