git

Documentation

Index

• Constants
• func IsSnapshotVersion(version string) bool
• func ProjectBranch(gitDir string) (string, error)
• func ProjectRevision(gitDir string) (string, error)
• func ProjectVersion(gitDir string) (string, error)
• type ProjectInfo
  • func NewProjectInfo(gitDir string) (ProjectInfo, error)

Constants

const Unspecified = "unspecified"

Functions

func IsSnapshotVersion

func IsSnapshotVersion(version string) bool

func ProjectBranch

func ProjectBranch(gitDir string) (string, error)

func ProjectRevision

func ProjectRevision(gitDir string) (string, error)

func ProjectVersion

func ProjectVersion(gitDir string) (string, error)

ProjectVersion returns the version string for the git repository that the provided directory is in. The output is the output of "git describe --tags" followed by ".dirty" if the repository currently has any uncommitted changes. Returns an error if the provided path is not in a git root or if the git repository has no commits or no tags.

Types

type ProjectInfo

type ProjectInfo struct {
	Version  string
	Branch   string
	Revision string
}

func NewProjectInfo

func NewProjectInfo(gitDir string) (ProjectInfo, error)