Github API - Test Config

UpdateBranchProtectionRulePayload [object]

Autogenerated return type of UpdateBranchProtectionRule

Attributes
branchProtectionRule BranchProtectionRule

BranchProtectionRule [object]

A branch protection rule.

Implements
Node
Attributes
allowsDeletions Boolean

Can this branch be deleted.

allowsForcePushes Boolean

Are force pushes allowed on this branch.

blocksCreations Boolean

Is branch creation a protected operation.

branchProtectionRuleConflicts BranchProtectionRuleConflictConnection

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

bypassForcePushAllowances BypassForcePushAllowanceConnection

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

bypassPullRequestAllowances BypassPullRequestAllowanceConnection

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

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

The Node ID of the BranchProtectionRule object

isAdminEnforced Boolean

Can admins override branch protection.

lockAllowsFetchAndMerge Boolean

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 Boolean

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

matchingRefs RefConnection

Repository refs that are protected by this rule

pattern String

Identifies the protection rule pattern.

pushAllowances PushAllowanceConnection

A list push allowances for this branch protection rule.

repository Repository

The repository associated with this branch protection rule.

requireLastPushApproval Boolean

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

requiredApprovingReviewCount Int

Number of approving reviews required to update matching branches.

requiredDeploymentEnvironments String []

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

requiredStatusCheckContexts String []

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

requiredStatusChecks RequiredStatusCheckDescription []

List of required status checks 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.

requiresConversationResolution Boolean

Are conversations required to be resolved before merging.

requiresDeployments Boolean

Does this branch require deployment to specific environments before merging

requiresLinearHistory Boolean

Are merge commits prohibited from being pushed to this branch.

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 ReviewDismissalAllowanceConnection

A list review dismissal allowances for this branch protection rule.

API:
Github GraphQL API

The newly created BranchProtectionRule.

clientMutationId String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

A unique identifier for the client performing the mutation.

API:
Github GraphQL API