Struct git_cliff_core::repo::Repository

pub struct Repository { /* private fields */ }

Available on crate feature repo only.

Wrapper for Repository type from git2.

Implementations

impl Repository

pub fn init(path: PathBuf) -> Result<Self>

Initializes (opens) the repository.

pub fn commits( &self, range: Option<String>, include_path: Option<Vec<Pattern>>, exclude_path: Option<Vec<Pattern>> ) -> Result<Vec<Commit<'_>>>

Parses and returns the commits.

Sorts the commits by their time.

pub fn current_tag(&self) -> Option<String>

Returns the current tag.

It is the same as running git describe --tags

pub fn find_commit(&self, id: String) -> Option<Commit<'_>>

Returns the commit object of the given ID.

pub fn tags( &self, pattern: &Option<Regex>, topo_order: bool ) -> Result<IndexMap<String, String>>

Parses and returns a commit-tag map.

It collects lightweight and annotated tags.

pub fn upstream_remote(&self) -> Result<Remote>

Returns the remote of the upstream repository.

The strategy used here is the following:

Find the branch that HEAD points to, and read the remote configured for that branch returns the remote and the name of the local branch.