gitinfo

README

gitinfo

A tiny shim over debug.BuildInfo that extracts Git-specific VCS information.

License

MIT

Documentation

Index

• Variables
• type GitInfo
  • func MustReadGitInfo() *GitInfo
  • func ReadGitInfo() (*GitInfo, error)

Variables

var (
	ErrNoBuildInfo = errors.New("could not read build info")
	ErrNoGit       = errors.New("vcs is not git")
)

Types

type GitInfo

type GitInfo struct {
	Revision string
	Time     time.Time
	Modified bool
}

GitInfo is the git info for a build

func MustReadGitInfo

func MustReadGitInfo() *GitInfo

MustReadGitInfo returns GitInfo, or dev info when encountering an error

func ReadGitInfo

func ReadGitInfo() (*GitInfo, error)

ReadGitInfo returns the GitInfo for a build