gitver

package

v0.1.1 Latest Latest Go to latest Published: Apr 9, 2020 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const DefaultTemplate = "{{if .Dirty}}dirty-{{.User}}-{{end}}{{.Commits}}.{{.Hash}}"

DefaultTemplate Default template for formatting GitVersion using String()

This section is empty.

func GitBranch() (string, error)

GitBranch gets the current git branch

func GitProjectPaths(projects []string) ([]string, error)

GitProjectPaths gives absolute paths given project paths relative to the git root

func GitRootPath() (string, error)

GitRootPath retrieves the absolute path of the root of this versioned git tree

func SetWorkingDir(dir string)

SetWorkingDir sets the working directory for running git commands

type GitVersion struct {
	Branch  string
	Commits string
	Hash    string
	Dirty   bool
	User    string
}

GitVersion version information about one or more git projects

func New(paths []string) (*GitVersion, error)

New creates a new GitVersion for the specified paths

func (ver *GitVersion) FormatTemplate(templateString string) (string, error)

FormatTemplate formats a GitVersion using a text/template string

func (ver *GitVersion) String() string