git

Documentation

Index

• Variables
• func CurrentCommit(path string) (string, error)
• func EnsureGivenPatternIsInGitignore(fs afero.Fs, repoRoot string, pattern string) (err error)
• type Repo
  • func FindRepoFromPath(path string) (*Repo, error)
  • func FindRepoInSubtree(root string) (*Repo, error)
• type RepoFinder
  • func (*RepoFinder) Repo(path string) (*Repo, error)

Variables

var (
	ErrNoGitRepoFound = errors.New("no git repository found")
)

Functions

func CurrentCommit

func CurrentCommit(path string) (string, error)

func EnsureGivenPatternIsInGitignore

func EnsureGivenPatternIsInGitignore(fs afero.Fs, repoRoot string, pattern string) (err error)

Types

type Repo

type Repo struct {
	Path string `json:"path"`
}

Repo represents the path of a given git repository.

func FindRepoFromPath

func FindRepoFromPath(path string) (*Repo, error)

func FindRepoInSubtree

func FindRepoInSubtree(root string) (*Repo, error)

FindRepoInSubtree finds the git repository in the subtree specified by path. In contrast to FindRepoFromPath, this functions decends down into a directory, and returns the first repository it finds.

type RepoFinder

type RepoFinder struct{}

RepoFinder is a wrapper for finding the root path of a git repository.

func (*RepoFinder) Repo

func (*RepoFinder) Repo(path string) (*Repo, error)

Repo uses git by spawning a process to locate the top level directory.