git

Documentation

Index

• Variables
• type Description
  • func ParseDescription(s string) (*Description, error)
• type Stats
  • func Stat(dir string) (*Stats, error)
• type VersionInfo
  • func LastSemanticTag(dir string) (string, *VersionInfo, error)
  • func ParseVersion(d Description) (*VersionInfo, error)

Variables

var ErrNoTags = errors.New("repository has no tags (git describe failed)")

var ErrNotInsideWorktree = errors.New("dir is outside of git worktree")

Types

type Description

type Description struct {
	Tag               string
	AdditionalCommits int // number of additional commits after the last tag
	ShortHash         string
}

Description contains the results of parsing the git describe output

func ParseDescription

func ParseDescription(s string) (*Description, error)

ParseDescription parses the result of `git describe --long`

type Stats

type Stats struct {
	Branch      string      // result of `git branch --show-current`
	Description Description // result of `git describe --long` command
	Hash        string      // result of `git rev-parse HEAD` command
	ShortHash   string      // result of `git rev-parse --short HEAD` command
	AuthorDate  string      // result of `git log -n1 --date=format:"%Y-%m-%dT%H:%M:%S" --format=%ad`
	Dirty       bool        // repo returns non-empty `git status --porcelain`
}

Stats contains a set of git statistics

func Stat

func Stat(dir string) (*Stats, error)

Stat obtains git stats for a specified local directory

type VersionInfo

type VersionInfo struct {
	SemanticTag       version.Semantic // as parsed from tag
	Semantic          version.Semantic // with additional commits, if != 0
	AdditionalCommits int
	Quad              version.Quad
	Pre               string // semantic pre-release suffix
	Build             string // semantic build suffix
}

VersionInfo contains version information in various formats

func LastSemanticTag

func LastSemanticTag(dir string) (string, *VersionInfo, error)

func ParseVersion

func ParseVersion(d Description) (*VersionInfo, error)

ParseVersion extracts useful version info from git.Stat description