Struct git_cliff_core::repo::Repository

pub struct Repository { /* fields omitted */ }

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 tags(
    &self,
    pattern: &Option<String>,
    topo_order: bool
) -> Result<IndexMap<String, String>>

Parses and returns a commit-tag map.

It collects lightweight and annotated tags.