BranchProtectionRuleConflict [object]
A conflict between two branch protection rules.
Attributes
BranchProtectionRule [object]
A branch protection rule.
Implements
Attributes
Can this branch be deleted.
Are force pushes allowed on this branch.
Is branch creation a protected operation.
A list of conflicts matching branches protection rule and other branch protection rules
A list of actors able to force push for this branch protection rule.
A list of actors able to bypass PRs for this branch protection rule.
The actor who created this branch protection rule.
Identifies the primary key from the database.
Will new commits pushed to matching branches dismiss pull request review approvals.
The Node ID of the BranchProtectionRule object
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.
Repository refs that are protected by this rule
Identifies the protection rule pattern.
A list push allowances for this branch protection rule.
The repository associated with this branch protection rule.
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.
List of required deployment environments that must be deployed successfully to update matching branches
List of required status check contexts that must pass for commits to be accepted to matching branches.
List of required status checks that must pass for commits to be accepted to matching branches.
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.
Does this branch require deployment to specific environments 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 review dismissal allowances for this branch protection rule.
Identifies the branch protection rule.
BranchProtectionRule [object]
A branch protection rule.
Implements
Attributes
Can this branch be deleted.
Are force pushes allowed on this branch.
Is branch creation a protected operation.
A list of conflicts matching branches protection rule and other branch protection rules
A list of actors able to force push for this branch protection rule.
A list of actors able to bypass PRs for this branch protection rule.
The actor who created this branch protection rule.
Identifies the primary key from the database.
Will new commits pushed to matching branches dismiss pull request review approvals.
The Node ID of the BranchProtectionRule object
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.
Repository refs that are protected by this rule
Identifies the protection rule pattern.
A list push allowances for this branch protection rule.
The repository associated with this branch protection rule.
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.
List of required deployment environments that must be deployed successfully to update matching branches
List of required status check contexts that must pass for commits to be accepted to matching branches.
List of required status checks that must pass for commits to be accepted to matching branches.
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.
Does this branch require deployment to specific environments 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 review dismissal allowances for this branch protection rule.
Identifies the conflicting branch protection rule.
Ref [object]
Represents a Git reference.
Implements
Attributes
A list of pull requests with this ref as the head ref.
Branch protection rules for this ref
Compares the current ref as a base ref to another head ref, if the comparison can be made.
The Node ID of the Ref object
The ref name.
The ref's prefix, such as refs/heads/
or refs/tags/
.
Branch protection rules that are viewable by non-admins
The repository the ref belongs to.
A list of rules from active Repository and Organization rulesets that apply to this ref.
The object the ref points to. Returns null when object does not exist.
Identifies the branch ref that has conflicting rules