Object GitHub::BranchProtectionRule

A branch protection rule.

Fields

branchProtectionRuleConflicts(after: String, before: String, first: Int, last: Int): BranchProtectionRuleConflictConnection!

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

Args

after: String

Returns the elements in the list that come after the specified cursor.

before: String

Returns the elements in the list that come before the specified cursor.

first: Int

Returns the first n elements from the list.

last: Int

Returns the last n elements from the list.

creator: Actor

The actor who created this branch protection rule.

databaseId: Int

Identifies the primary key from the database.

dismissesStaleReviews: Boolean!

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

id: ID!

isAdminEnforced: Boolean!

Can admins overwrite branch protection.

matchingRefs(query: String, after: String, before: String, first: Int, last: Int): RefConnection!

Repository refs that are protected by this rule

Args

query: String

Filters refs with query on name

after: String

Returns the elements in the list that come after the specified cursor.

before: String

Returns the elements in the list that come before the specified cursor.

first: Int

Returns the first n elements from the list.

last: Int

Returns the last n elements from the list.

pattern: String!

Identifies the protection rule pattern.

pushAllowances(after: String, before: String, first: Int, last: Int): PushAllowanceConnection!

A list push allowances for this branch protection rule.

Args

after: String

Returns the elements in the list that come after the specified cursor.

before: String

Returns the elements in the list that come before the specified cursor.

first: Int

Returns the first n elements from the list.

last: Int

Returns the last n elements from the list.

repository: Repository

The repository associated with this branch protection rule.

requiredApprovingReviewCount: Int

Number of approving reviews required to update matching branches.

requiredStatusCheckContexts: [String]

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

requiresApprovingReviews: Boolean!

Are approving reviews required to update matching branches.

requiresCodeOwnerReviews: Boolean!

Are reviews from code owners required to update matching branches.

requiresCommitSignatures: Boolean!

Are commits required to be signed.

requiresStatusChecks: Boolean!

Are status checks required to update matching branches.

requiresStrictStatusChecks: Boolean!

Are branches required to be up to date before merging.

restrictsPushes: Boolean!

Is pushing to matching branches restricted.

restrictsReviewDismissals: Boolean!

Is dismissal of pull request reviews restricted.

reviewDismissalAllowances(after: String, before: String, first: Int, last: Int): ReviewDismissalAllowanceConnection!

A list review dismissal allowances for this branch protection rule.

Args

after: String

Returns the elements in the list that come after the specified cursor.

before: String

Returns the elements in the list that come before the specified cursor.

first: Int

Returns the first n elements from the list.

last: Int

Returns the last n elements from the list.

Uses

BranchProtectionRuleConflict.branchProtectionRule

BranchProtectionRuleConflict.conflictingBranchProtectionRule

BranchProtectionRuleConnection.nodes

BranchProtectionRuleEdge.node

CreateBranchProtectionRulePayload.branchProtectionRule

PushAllowance.branchProtectionRule

ReviewDismissalAllowance.branchProtectionRule

UpdateBranchProtectionRulePayload.branchProtectionRule

Node