Struct git_checks::checks::ReleaseBranch

pub struct ReleaseBranch { /* fields omitted */ }

A check which checks for release branch eligibility.

Methods

impl ReleaseBranch

pub fn new<B, C>(branch: B, commit: C) -> Self where
    B: ToString,
    C: ToString, 

Create a check which checks that a branch is eligible for a release branch.

By default, it only messages that a branch is eligible.

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

Set whether the eligibility is required.

Use this for release branches to check that they do not bring in unwanted history.

Trait Implementations

impl BranchCheck for ReleaseBranch

fn name(&self) -> &str

The name of the check.

fn check(&self, ctx: &CheckGitContext, commit: &CommitId) -> Result<CheckResult>

Run the check.

impl Debug for ReleaseBranch

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

Formats the value using the given formatter.