Struct Bump 

pub struct Bump {
    pub features_always_bump_minor: Option<bool>,
    pub breaking_always_bump_major: Option<bool>,
    pub initial_tag: Option<String>,
    pub custom_major_increment_regex: Option<String>,
    pub custom_minor_increment_regex: Option<String>,
    pub no_increment_regex: Option<String>,
    pub bump_type: Option<BumpType>,
}

Bump version configuration.

Fields

features_always_bump_minor: Option<bool>

Configures automatic minor version increments for feature changes.

When true, a feature will always trigger a minor version update. When false, a feature will trigger:

• A patch version update if the major version is 0.
• A minor version update otherwise.

breaking_always_bump_major: Option<bool>

Configures 0 -> 1 major version increments for breaking changes.

When true, a breaking change commit will always trigger a major version update (including the transition from version 0 to 1) When false, a breaking change commit will trigger:

• A minor version update if the major version is 0.
• A major version update otherwise.

initial_tag: Option<String>

Configures the initial version of the project.

When set, the version will be set to this value if no tags are found.

custom_major_increment_regex: Option<String>

Configure a custom regex pattern for major version increments.

This will check only the type of the commit against the given pattern.

Note

commit type according to the spec is only [a-zA-Z]+

custom_minor_increment_regex: Option<String>

Configure a custom regex pattern for minor version increments.

This will check only the type of the commit against the given pattern.

Note

commit type according to the spec is only [a-zA-Z]+

no_increment_regex: Option<String>

Configure a regex pattern for commit types that should not increment.

This will check only the type of the commit against the given pattern.

Note

commit type according to the spec is only [a-zA-Z]+

bump_type: Option<BumpType>

Force to always bump in major, minor or patch.

Implementations

impl Bump

pub fn get_initial_tag(&self) -> String

Returns the initial tag.

This function also logs the returned value.

Trait Implementations

impl Clone for Bump

fn clone(&self) -> Bump

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bump

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

Formats the value using the given formatter.

impl Default for Bump

fn default() -> Bump

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bump

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Bump

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.