git

package

v0.0.0-...-c25e923 Latest Latest Go to latest Published: Oct 16, 2023 License: MPL-2.0 Imports: 12 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

Package git provides helpers for SCM.

This section is empty.

This section is empty.

This section is empty.

type Git struct {
	// contains filtered or unexported fields
}

Git is a helper for git.

func NewGit() (*Git, error)

NewGit instantiates and returns a Git struct.

func (g *Git) AheadBehind(ref string) (ahead, behind int, err error)

AheadBehind returns the number of commits that HEAD is ahead and behind relative to the specified ref.

func (g *Git) CheckoutPullRequest(number int) (err error)

CheckoutPullRequest checks out pull request.

func (g *Git) FetchPullRequest(remote string, number int) (err error)

FetchPullRequest fetches a remote PR.

func (g *Git) HasGPGSignature() (ok bool, err error)

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

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) Messages(commit1, commit2 string) ([]string, error)

Messages returns the list of commit messages in the range commit1..commit2.

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

SHA returns the sha of the current commit.

func (g *Git) VerifyPGPSignature(armoredKeyrings []string) (*openpgp.Entity, error)

VerifyPGPSignature validates PGP signature against a keyring.