Struct Commits

pub struct Commits { /* private fields */ }

A representation of a range of commits within a Git repository, which can have various lints performed upon it after construction.

Implementations

impl Commits

pub fn from_reference<T: AsRef<str>>( repository: &Repository, reference: T, ) -> Result<Commits, Error>

Create a new range of commits from a reference exclusively from the commit specified by the reference till inclusively of HEAD.

Supports providing either the full or short name of the reference.

E.g. short name.

use git2::Repository;
use clean_git_history_lib::Commits;

let repository = Repository::open_from_env().unwrap();
let commits = Commits::from_reference(&repository, "v1.0.0");

E.g. full name.

use git2::Repository;
use clean_git_history_lib::Commits;

let repository = Repository::open_from_env().unwrap();
let commits = Commits::from_reference(&repository, "refs/tags/v1.0.0");

pub fn from_commit_hash<T: AsRef<str>>( repository: &Repository, commit_hash: T, ) -> Result<Commits, Error>

Create a new range of commits from a commit hash exclusively from the commit specified till inclusively of HEAD.

Supports providing either the full commit hash or a shortened commit hash.

E.g. shortened commit hash.

use git2::Repository;
use clean_git_history_lib::Commits;

let repository = Repository::open_from_env().unwrap();
let commits = Commits::from_commit_hash(&repository, "d58f1598");

E.g. full commit hash.

use git2::Repository;
use clean_git_history_lib::Commits;

let repository = Repository::open_from_env().unwrap();
let commits = Commits::from_commit_hash(&repository, "d58f159849a1551dbe7f67019208c2e0de08da80");

pub fn contains_merge_commits(&self) -> bool

A lint that can be performed on the range of commits, which returns true if any of the commits are merge commits, i.e. has multiple parents.