gitutil

Documentation

Overview

Package gitutil provides convenient interfaces for operating git.

Dependency: git needs to be installed locally

Index

• Variables
• func GetHeadHash() (sha string, err error)
• func GetHeadHashShort() (sha string, err error)
• func GetLatestTag() (string, error)
• func GetLatestTagFromLocal() (tag string, err error)
• func GetLatestTagFromRemote() (tag string, err error)
• func GetRemoteURL() (string, error)
• func GetTagCommitSha(tag string) (sha string, err error)
• func GetTagCommitShaFromLocal(tag string) (sha string, err error)
• func GetTagCommitShaFromRemote(_ string) (string, error)
• func GetTagList() (tags []string, err error)
• func GetTagListFromRemote(remoteURL string, reverse bool) (tags []string, err error)
• func IsDirty() (dirty bool, err error)
• func IsHeadAtTag(tag string) (bool, error)

Variables

var ErrEmptyGitTag = errors.New("empty tag")

Functions

func GetHeadHash

func GetHeadHash() (sha string, err error)

func GetHeadHashShort

func GetHeadHashShort() (sha string, err error)

func GetLatestTag

func GetLatestTag() (string, error)

func GetLatestTagFromLocal

func GetLatestTagFromLocal() (tag string, err error)

func GetLatestTagFromRemote

func GetLatestTagFromRemote() (tag string, err error)

get latest tag from remote, the fitting git clone depth is 1

func GetRemoteURL

func GetRemoteURL() (string, error)

get remote url

func GetTagCommitSha

func GetTagCommitSha(tag string) (sha string, err error)

func GetTagCommitShaFromLocal

func GetTagCommitShaFromLocal(tag string) (sha string, err error)

func GetTagCommitShaFromRemote

func GetTagCommitShaFromRemote(_ string) (string, error)

get tag commit sha from remote, the fitting git clone depth is 1

func GetTagList

func GetTagList() (tags []string, err error)

func GetTagListFromRemote

func GetTagListFromRemote(remoteURL string, reverse bool) (tags []string, err error)

func IsDirty

func IsDirty() (dirty bool, err error)

func IsHeadAtTag

func IsHeadAtTag(tag string) (bool, error)