Struct GitRepo 

pub struct GitRepo { /* private fields */ }

Repository wrapper.

Implementations

impl GitRepo

pub fn discover(path: &Path) -> Result<Self>

Discover and open the repository by searching path and its parents for .git.

pub fn workdir(&self) -> Option<&Path>

Root of the repository working tree.

pub fn git_dir(&self) -> &Path

Path to the .git directory (used to compute the cache location).

pub fn head_ref_name(&self) -> String

Canonical ref name of HEAD (or the short SHA when detached).

pub fn refs_snapshot(&self) -> Result<Vec<String>>

Sorted list of "<name> <target_sha>" for every ref. Used as the refs snapshot in the cache key.

pub fn head_commit(&self) -> Result<CommitInfo>

The commit that HEAD points to.

pub fn current_branch_name(&self) -> Result<String>

Friendly name of the currently checked-out branch.

When HEAD is detached, mirrors the original GitVersion (GitVersionContextFactory) GetBranchesContainingCommit(...).OnlyOrDefault() logic: if a branch has HEAD as its tip (direct match), that branch is used; otherwise the first branch that contains HEAD as a reachable ancestor is used. Exactly one match returns its name; zero or multiple matches return (no branch). (When CI checks out a tag as detached HEAD, HEAD may not be the tip of main, so tip-only matching is insufficient.)

pub fn tags(&self) -> Result<Vec<TagInfo>>

Collect all tags together with the commits they point to.

pub fn branch_names(&self) -> Result<Vec<String>>

Shorthand names of all local and remote branches.

pub fn commits_between( &self, from: Option<&str>, to: &str, ) -> Result<Vec<CommitInfo>>

Returns reachable commits from from (exclusive) to to (inclusive), newest first. When from is None, returns all ancestors of to.

pub fn first_parent_between( &self, from: Option<&str>, to: &str, ) -> Result<Vec<CommitInfo>>

Returns commits from from (exclusive) to to (inclusive) following first parents only, newest first. Used for Mainline trunk traversal.

pub fn merge_base(&self, a: &str, b: &str) -> Result<Option<String>>

Merge-base of two commits.

pub fn is_ancestor_of_head(&self, sha: &str) -> Result<bool>

Returns true if the given commit is reachable from HEAD (i.e. is an ancestor).

pub fn is_ancestor_of(&self, ancestor: &str, descendant: &str) -> Result<bool>

Returns true if ancestor is an ancestor of (or identical to) descendant.

pub fn changed_paths_for_commit(&self, sha: &str) -> Vec<String>

File paths changed by a commit relative to its first parent. Returns an empty vec for root commits or when the diff cannot be obtained.

pub fn commit_info_of(&self, spec: &str) -> Option<CommitInfo>

Resolve a spec (branch/tag/SHA) to a CommitInfo.

pub fn local_branch_names(&self) -> Result<Vec<String>>

Sorted list of shorthand local branch names.

pub fn create_tag(&self, name: &str, target_spec: Option<&str>) -> Result<()>

Create a lightweight tag on the specified commit (defaults to HEAD).

pub fn create_branch(&self, name: &str, target_spec: Option<&str>) -> Result<()>

Create a branch ref on the specified commit (defaults to HEAD). Does not touch the working tree.

pub fn clear_cache(&self) -> Result<usize>

Delete the on-disk cache directory (<.git>/gitversion_cache).

pub fn uncommitted_changes(&self) -> Result<i64>

Number of uncommitted changes in the working tree.

pub fn tags_on_commit(&self, sha: &str) -> Result<HashSet<String>>

Names of tags directly attached to the given commit.