Interface BranchProtection

BranchProtection represents a branch protection for a repository

Hierarchy

  • BranchProtection

Properties

approvals_whitelist_teams?: string[]
approvals_whitelist_username?: string[]
block_admin_merge_override?: boolean
block_on_official_review_requests?: boolean
block_on_outdated_branch?: boolean
block_on_rejected_reviews?: boolean
branch_name?: string

Deprecated: true

created_at?: string

Format

date-time

dismiss_stale_approvals?: boolean
enable_approvals_whitelist?: boolean
enable_force_push?: boolean
enable_force_push_allowlist?: boolean
enable_merge_whitelist?: boolean
enable_push?: boolean
enable_push_whitelist?: boolean
enable_status_check?: boolean
force_push_allowlist_deploy_keys?: boolean
force_push_allowlist_teams?: string[]
force_push_allowlist_usernames?: string[]
ignore_stale_approvals?: boolean
merge_whitelist_teams?: string[]
merge_whitelist_usernames?: string[]
priority?: number

Format

int64

protected_file_patterns?: string
push_whitelist_deploy_keys?: boolean
push_whitelist_teams?: string[]
push_whitelist_usernames?: string[]
require_signed_commits?: boolean
required_approvals?: number

Format

int64

rule_name?: string
status_check_contexts?: string[]
unprotected_file_patterns?: string
updated_at?: string

Format

date-time

Generated using TypeDoc