gut

Documentation

Overview

Package gut (git utils) implements some Helper Functions around the `git` Library to easier interact with the Repository.

Deprecated: The gut package is marked as deprecated since we will drop the git dependency in the future.

Index

• func FindGitRoot(base string) (string, error)
• func GetAuthorName() (string, error)
• func GetCurrentBranchFromRepository(repository *git.Repository) (string, error)

Functions

func FindGitRoot

func FindGitRoot(base string) (string, error)

FindGitRoot returns the last found `.git` Directory from the base Means if your are in $PATH/cmd/test and the Git Root is $PATH/ FuncGitRoot will return $PATH/ It will return an Error if the `.git/` Directory could not be found.

Deprecated: The gut package is marked as deprecated since we will drop the git dependency in the future.

func GetAuthorName

func GetAuthorName() (string, error)

GetAuthorName returns the author name configured in the git config

Deprecated: The gut package is marked as deprecated since we will drop the git dependency in the future.

func GetCurrentBranchFromRepository

func GetCurrentBranchFromRepository(repository *git.Repository) (string, error)

GetCurrentBranchFromRepository does return the current checked out branch from the repository.

Deprecated: The gut package is marked as deprecated since we will drop the git dependency in the future.