Struct Changes 

pub struct Changes { /* private fields */ }

Structure that represents the changes in a git repository

Implementations

impl Changes

pub fn from_repo( repository: &impl RepositoryExtension, ) -> Result<Self, Box<dyn Error>>

Sort the commits from a given repo into major, minor, patch and other change categories according to their commit intentions.

Commits are fetched since the latest version tag. If there are no version tags yet then all the commits from the repository are fetched.

Returns

The Changes structure with the sorted commits or error type.

Example

use git2::Repository;
use cargo_semantic_release::Changes;

let git_repo = Repository::open(".").unwrap();

let changes = Changes::from_repo(&git_repo).expect("error during fetching changes");
println!("changes: {changes}")

pub fn define_action_for_semantic_version(self) -> SemanticVersionAction

Evaluate the changes find in a repository to figure out the semantic version action

Returns

SemanticVersionAction enum for the suggested semantic version change.

Example

 use git2::Repository;
 use cargo_semantic_release::Changes;

 let git_repo = Repository::open(".").unwrap();

 let action = Changes::from_repo(&git_repo).expect("Error during fetching changes").define_action_for_semantic_version();
 println!("suggested change of semantic version: {}", action);

Trait Implementations

impl Debug for Changes

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

Formats the value using the given formatter.

impl Display for Changes

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

Format the values in Changes

Example output:

major:
        :boom: Introduce breaking change

minor:
        :sparkles: Add new feature

patch:
        :recycle: Refactor codebase

other:
        :bulb: Add comments

impl PartialEq for Changes

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

Compare two Changes struct to see if they have the same elements.

Returns

true if the two structure has the same elements regardless they order, false otherwise.

Example

use git2::AttrValue::True;
use git2::Repository;
use cargo_semantic_release::Changes;

let git_repo = Repository::open(".").unwrap();

let changes_1 = Changes::from_repo(&git_repo).expect("error during fetching changes");
let changes_2 = Changes::from_repo(&git_repo).expect("error during fetching changes");

assert_eq!(changes_1, changes_2);

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

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

impl TryFrom<&Repository> for Changes

type Error = Box<dyn Error>

The type returned in the event of a conversion error.

fn try_from(value: &Repository) -> Result<Self, Self::Error>

Performs the conversion.