Struct PullRequestBuildPolicy

#[non_exhaustive]
pub struct PullRequestBuildPolicy {
    pub requires_comment_approval: PullRequestBuildCommentApproval,
    pub approver_roles: Option<Vec<PullRequestBuildApproverRole>>,
}

A PullRequestBuildPolicy object 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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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)

approver_roles: Option<Vec<PullRequestBuildApproverRole>>

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.

Implementations

impl PullRequestBuildPolicy

pub fn requires_comment_approval(&self) -> &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)

pub fn approver_roles(&self) -> &[PullRequestBuildApproverRole]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .approver_roles.is_none().

impl PullRequestBuildPolicy

pub fn builder() -> PullRequestBuildPolicyBuilder

Creates a new builder-style object to manufacture PullRequestBuildPolicy.

Trait Implementations

impl Clone for PullRequestBuildPolicy

fn clone(&self) -> PullRequestBuildPolicy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PullRequestBuildPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PullRequestBuildPolicy

fn eq(&self, other: &PullRequestBuildPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PullRequestBuildPolicy