Skip to content

PullRequestBuildPolicy

Used by
Source code in docs_src/capo_codebuild/types/pull_request_build_policy.py 
14
15
16
17
18
19
20
class PullRequestBuildPolicy(TypedDict, closed=True):
    requires_comment_approval: "capo_codebuild.types.pull_request_build_comment_approval.PullRequestBuildCommentApproval"
    """<p>Specifies when comment-based approval is required before triggering a build on pull requests. This setting determines whether builds run automatically or require explicit approval through comments.</p> <ul> <li> <p> <i>DISABLED</i>: Builds trigger automatically without requiring comment approval</p> </li> <li> <p> <i>ALL_PULL_REQUESTS</i>: All pull requests require comment approval before builds execute (unless contributor is one of the approver roles)</p> </li> <li> <p> <i>FORK_PULL_REQUESTS</i>: Only pull requests from forked repositories require comment approval (unless contributor is one of the approver roles)</p> </li> </ul>"""
    approver_roles: NotRequired[
        "capo_codebuild.types.pull_request_build_approver_roles.PullRequestBuildApproverRoles"
    ]
    """<p>List of repository roles that have approval privileges for pull request builds when comment approval is required. Only users with these roles can provide valid comment approvals. If a pull request contributor is one of these roles, their pull request builds will trigger automatically. This field is only applicable when <code>requiresCommentApproval</code> is not <i>DISABLED</i>.</p>"""

approver_roles instance-attribute 

approver_roles: NotRequired[PullRequestBuildApproverRoles]

List of repository roles that have approval privileges for pull request builds when comment approval is required. Only users with these roles can provide valid comment approvals. If a pull request contributor is one of these roles, their pull request builds will trigger automatically. This field is only applicable when requiresCommentApproval is not DISABLED.

requires_comment_approval instance-attribute 

requires_comment_approval: PullRequestBuildCommentApproval

Specifies when comment-based approval is required before triggering a build on pull requests. This setting determines whether builds run automatically or require explicit approval through comments.

  • DISABLED: Builds trigger automatically without requiring comment approval

  • ALL_PULL_REQUESTS: All pull requests require comment approval before builds execute (unless contributor is one of the approver roles)

  • FORK_PULL_REQUESTS: Only pull requests from forked repositories require comment approval (unless contributor is one of the approver roles)