util

Documentation

Index

• Variables
• func GetGitAuthor() (string, string, error)
• func GetLatestParentCommit(commit *object.Commit) (*object.Commit, error)
• func LatestTagCommitHash(repo GitRepoIface, branchRef string) (*string, *plumbing.Hash, error)
• func VerifyDefaultBranch(repo GitRepoIface, defaultBranchRef string) (*object.Commit, error)
• func VersionCacheKey() string
• func VersionString() (string, error)
• type GitRepoIface

Variables

var (
	// Version is the bff version
	Version = "undefined"
	// GitSha is the gitsha used to build this version
	GitSha = "undefined"
	// Release is true if this is a release
	Release = "false"
	// Dirty if git is dirty
	Dirty = "true"
)

Functions

func GetGitAuthor

func GetGitAuthor() (string, string, error)

GetGitAuthor returns the author name and email

func GetLatestParentCommit

func GetLatestParentCommit(commit *object.Commit) (*object.Commit, error)

GetLatestParentCommit returns the most recent parent commit

func LatestTagCommitHash

func LatestTagCommitHash(repo GitRepoIface, branchRef string) (*string, *plumbing.Hash, error)

LatestTagCommitHash will get the latest tag and commit hash for a repo

func VerifyDefaultBranch

func VerifyDefaultBranch(repo GitRepoIface, defaultBranchRef string) (*object.Commit, error)

VerifyDefaultBranch returns the default branch's commit, according to HEAD

func VersionCacheKey

func VersionCacheKey() string

VersionCacheKey returns a key to version the cache

func VersionString

func VersionString() (string, error)

VersionString returns the version string

Types

type GitRepoIface

type GitRepoIface interface {
	CommitObject(h plumbing.Hash) (*object.Commit, error)
	Head() (*plumbing.Reference, error)
	Log(o *git.LogOptions) (object.CommitIter, error)
	Reference(name plumbing.ReferenceName, resolved bool) (*plumbing.Reference, error)
	Tags() (storer.ReferenceIter, error)
}