Enum next_version::VersionIncrement

pub enum VersionIncrement {
    Major,
    Minor,
    Patch,
    Prerelease,
}

Variants

Major

Minor

Patch

Prerelease

Implementations

impl VersionIncrement

pub fn from_commits<I>(current_version: &Version, commits: I) -> Option<Self>

where I: IntoIterator, I::Item: AsRef<str>,

Analyze commits and determine which part of version to increment based on conventional commits and Semantic versioning.

• If no commits are present, Option::None is returned, because the version should not be incremented.
• If some commits are present and semver::Prerelease is not empty, the version increment is VersionIncrement::Prerelease.
• If some commits are present, but none of them match conventional commits specification, the version increment is VersionIncrement::Patch.
• If some commits match conventional commits, then the next version is calculated by using these rules.

pub fn breaking(current_version: &Version) -> Self

Increments the version to take into account breaking changes.

use next_version::VersionIncrement;
use semver::Version;

let increment = VersionIncrement::breaking(&Version::new(0, 3, 3));
assert_eq!(increment, VersionIncrement::Minor);

let increment = VersionIncrement::breaking(&Version::new(1, 3, 3));
assert_eq!(increment, VersionIncrement::Major);

let increment = VersionIncrement::breaking(&Version::parse("1.3.3-alpha.1").unwrap());
assert_eq!(increment, VersionIncrement::Prerelease);

impl VersionIncrement

pub fn bump(&self, version: &Version) -> Version

Trait Implementations

impl Debug for VersionIncrement

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

Formats the value using the given formatter.

impl PartialEq for VersionIncrement

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for VersionIncrement

impl StructuralEq for VersionIncrement

impl StructuralPartialEq for VersionIncrement