git

package

v0.1.0-alpha.3 Latest Latest Go to latest Published: Oct 16, 2019 License: MPL-2.0 Imports: 11 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

This section is empty.

This section is empty.

This section is empty.

type Git struct {
	Filesystem billy.Filesystem
	// contains filtered or unexported fields
}

Git is a helper for git.

func NewGit() (g *Git, err error)

NewGit instantiates and returns a Git struct.

func NewGitFromClone(url string, ref plumbing.ReferenceName) (g *Git, err error)

NewGitFromClone instantiates and returns a Git struct.

func (g *Git) Branch() (branch string, isBranch bool, err error)

Branch returns the current git branch name.

func (g *Git) Describe() (result string, err error)

Describe returns git describe-based version.

If no tags are present: `8513435-dirty` or `8513435`

Exactly on the tag `v0.1`: `v0.1-dirty` or `v0.1`

Some commits ahead of tag `v0.1`: `v0.1-1-g23cbce5` (1 commit ahead, `g` followed by abbreviated git SHA).

func (g *Git) Message() (message string, err error)

Message returns the commit message. In the case that a commit has multiple parents, the message of the last parent is returned.

func (g *Git) Ref() (ref string, err error)

Ref returns the current git ref name.

func (g *Git) SHA() (sha string, err error)

SHA returns the sha of the current commit.

func (g *Git) Status() (status string, isClean bool, err error)

Status returns the status of the working tree.

func (g *Git) Tag() (tag string, isTag bool, err error)

Tag returns the tag name if HEAD is a tag.