The highest tagged major version is v3.

commitlog

package

v1.0.0 Latest Latest Go to latest Published: Apr 19, 2022 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/barelyhuman/commitlog

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GetCommitFromString(commitString string, repo *git.Repository) *object.Commit
func IsHashATag(currentRepository *git.Repository, hash plumbing.Hash) bool
func OpenRepository(path string) *git.Repository
type ErrMessage
- func CommitLog(currentRepository *git.Repository, startCommitString string, ...) (string, ErrMessage)

Constants ¶

View Source

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

SupportedKeys - keys that are supported by the package

Variables ¶

This section is empty.

Functions ¶

func GetCommitFromString ¶

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

GetCommitFromString - get commit from hash string

func IsHashATag ¶ added in v0.0.10

func IsHashATag(currentRepository *git.Repository, hash plumbing.Hash) bool

func OpenRepository ¶ added in v0.0.9

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(currentRepository *git.Repository, startCommitString string, endCommitString string, inclusionFlags string, skipClassification bool, addPromotional bool) (string, ErrMessage)

CommitLog - Generate commit log

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL