Skip to main content

required_pull_request_reviews

Overview

Namerequired_pull_request_reviews
TypeResource
Idgithub.repos.required_pull_request_reviews

Fields

NameDatatypeDescription
urlstring
bypass_pull_request_allowancesobjectAllow specific users or teams to bypass pull request requirements. Set to null to disable.
dismiss_stale_reviewsboolean
dismissal_restrictionsobject
require_code_owner_reviewsboolean
required_approving_review_countinteger

Methods

NameAccessible byRequired ParamsDescription
get_pull_request_review_protectionSELECTbranch, owner, repoProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
delete_pull_request_review_protectionDELETEbranch, owner, repoProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
update_pull_request_review_protectionEXECbranch, owner, repoProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

Note: Passing new arrays of users and teams replaces their previous values.