git

Documentation

Overview

Package git provides utilities of working with the current .git repo

Index

• type ErrNotGitRepo
  • func (err ErrNotGitRepo) Error() string
• type InfoData
  • func Info(dir string) (gitInfo InfoData, err error)

Types

type ErrNotGitRepo

type ErrNotGitRepo struct {
	Cmd       *util.Cmd
	Directory string
}

ErrNotGitRepo is raised when given directory is not a .git repo

func (ErrNotGitRepo) Error

func (err ErrNotGitRepo) Error() string

Error returns printable error string

type InfoData

type InfoData struct {
	Sha      string
	Branch   string
	RepoName string
	Remote   string
	URL      string
	Message  string
	Author   string
}

InfoData is the data structure that describes info taken from the current .git repo

func Info

func Info(dir string) (gitInfo InfoData, err error)

Info gathers info from a given directory's .git repo