utils

Documentation

Index

• Variables
• type GitRepository
  • func FindGitRepository(fromPath string, fs billy.Filesystem) (*GitRepository, error)
  • func ReadRepository(path string, fs billy.Filesystem) (*GitRepository, error)
  • func (repo *GitRepository) Config() (*config.Config, error)
  • func (repo *GitRepository) Root() string
  • func (repo *GitRepository) SetConfig(conf *config.Config) error

Variables

var ErrFailedReadGitConfig = errors.New("Failed to read git config")

ErrFailedReadGitConfig signals failure to read .git/config

var ErrIsNotRepository = errors.New("This directory and all parents are not git repositories")

ErrIsNotRepository signals that no git repositories have been found

Types

type GitRepository

type GitRepository struct {
	// contains filtered or unexported fields
}

GitRepository implements the git-go storage.ConfigStorer interface

func FindGitRepository

func FindGitRepository(fromPath string, fs billy.Filesystem) (*GitRepository, error)

FindGitRepository finds the .git directory in the given directory, or any parents.

func ReadRepository

func ReadRepository(path string, fs billy.Filesystem) (*GitRepository, error)

ReadRepository creates a GitRepository given a fs, and the relative path to the repo in that fs.

func (*GitRepository) Config

func (repo *GitRepository) Config() (*config.Config, error)

Config reads a Config object from a GitRepository

func (*GitRepository) Root

func (repo *GitRepository) Root() string

Root prints the root directory of the GitRepository

func (*GitRepository) SetConfig

func (repo *GitRepository) SetConfig(conf *config.Config) error

SetConfig saves a config object to the GitRepository filesystem