PullRequestBuildPolicy
Configuration policy that defines comment-based approval requirements for triggering builds on pull requests. This policy helps control when automated builds are executed based on contributor permissions and approval workflows.
Contents
Note
In the following list, the required parameters are described first.
- requiresCommentApproval
-
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)
Type: String
Valid Values:
DISABLED | ALL_PULL_REQUESTS | FORK_PULL_REQUESTSRequired: Yes
-
- approverRoles
-
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
requiresCommentApprovalis not DISABLED.Type: Array of strings
Valid Values:
GITHUB_READ | GITHUB_TRIAGE | GITHUB_WRITE | GITHUB_MAINTAIN | GITHUB_ADMIN | GITLAB_GUEST | GITLAB_PLANNER | GITLAB_REPORTER | GITLAB_DEVELOPER | GITLAB_MAINTAINER | GITLAB_OWNER | BITBUCKET_READ | BITBUCKET_WRITE | BITBUCKET_ADMINRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
