Struct git_checks::builders::ReleaseBranchBuilder

pub struct ReleaseBranchBuilder { /* fields omitted */ }

Builder for ReleaseBranch.

Methods

impl ReleaseBranchBuilder

pub fn branch<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The branch name of the release being checked for.

Configuration: Required

pub fn disallowed_commit<VALUE: Into<CommitId>>(
    &mut self,
    value: VALUE
) -> &mut Self

The first commit on the target branch not allowed on the release branch.

This is usually the first commit on the main integration branch after the release branch forked from it.

Configuration: Required

pub fn required(&mut self, value: bool) -> &mut Self

Whether the check should error or just warn.

Configuration: Optional Default: false

pub fn build(&self) -> Result<ReleaseBranch, String>

Builds a new ReleaseBranch.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ReleaseBranchBuilder

fn clone(&self) -> ReleaseBranchBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ReleaseBranchBuilder

fn default() -> ReleaseBranchBuilder

Returns the "default value" for a type.