commitlog

Documentation

Index

• Constants
• func GetCommitFromString(commitString string, repo *git.Repository) *object.Commit
• func GetLatestTagFromRepository(repository *git.Repository) (*plumbing.Reference, *plumbing.Reference, error)
• func OpenRepository(path string) *git.Repository
• type ErrMessage
  • func CommitLog(path string, startCommitString string, endCommitString string, ...) (string, ErrMessage)

Constants

const SupportedKeys = "ci|refactor|docs|fix|feat|test|chore|other"

SupportedKeys - keys that are supported by the package

Functions

func GetCommitFromString

func GetCommitFromString(commitString string, repo *git.Repository) *object.Commit

GetCommitFromString - get commit from hash string

func GetLatestTagFromRepository

func GetLatestTagFromRepository(repository *git.Repository) (*plumbing.Reference, *plumbing.Reference, error)

GetLatestTagFromRepository - Get the latest Tag reference from the repo

func OpenRepository

func OpenRepository(path string) *git.Repository

OpenRepository - open the git repository and return repository reference

Types

type ErrMessage

type ErrMessage struct {
	Message string
	Err     error
}

ErrMessage - simple interface around error with a custom message

func CommitLog

func CommitLog(path string, startCommitString string, endCommitString string, inclusionFlags string, skipClassification bool) (string, ErrMessage)

CommitLog - Generate commit log