Struct ReleaseBranchConfig

pub struct ReleaseBranchConfig { /* private fields */ }

Configuration for the ReleaseBranch check.

The branch key is a string which defaults to release. This is the name of the branch which contains the version which is being checked. The disallowed_commit is a string with the full hash of the first commit which happened on the original branch after the release branch was created. The required key is a boolean defaulting to false which indicates whether the check is a hard failure or not.

This check is registered as a branch check with the name "branch_check".

Example

{
    "branch": "v1.x",
    "disallowed_commit": "post-branch commit hash",
    "required": true
}

Trait Implementations

impl Debug for ReleaseBranchConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReleaseBranchConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoCheck for ReleaseBranchConfig

type Check = ReleaseBranch

The check parsed by this configuration.

fn into_check(self) -> Self::Check

Create a new instance of the check from the configuration.