vcs

Documentation

Index

• func CheckBranch(repoPath string, config cfg.SinceConfig) error
• func CommitChangelog(repoPath string, changelogFile string, version string) (hash string, err error)
• func FetchCommitMessages(config cfg.SinceConfig, repoPath string, tag string, orderBy TagOrderBy, ...) ([]string, error)
• func GetHeadSha(repoPath string) (string, error)
• func GetLatestTag(repoPath string, orderBy TagOrderBy) (string, error)
• func TagRelease(repoPath string, hash string, version string) error
• type ReleaseMetadata
• type TagOrderBy

Functions

func CheckBranch

func CheckBranch(repoPath string, config cfg.SinceConfig) error

CheckBranch checks if the current branch is the required branch.

func CommitChangelog

func CommitChangelog(repoPath string, changelogFile string, version string) (hash string, err error)

CommitChangelog commits the changelog file.

func FetchCommitMessages

func FetchCommitMessages(
	config cfg.SinceConfig,
	repoPath string,
	tag string,
	orderBy TagOrderBy,
	unique bool,
) ([]string, error)

FetchCommitMessages returns a slice of commit messages after the given tag.

func GetHeadSha

func GetHeadSha(repoPath string) (string, error)

GetHeadSha returns the SHA of the HEAD commit.

func GetLatestTag

func GetLatestTag(repoPath string, orderBy TagOrderBy) (string, error)

GetLatestTag returns the latest tag in the repository.

func TagRelease

func TagRelease(repoPath string, hash string, version string) error

TagRelease tags the repository with the given version.

Types

type ReleaseMetadata

type ReleaseMetadata struct {
	NewVersion string
	OldVersion string
	RepoPath   string
	Sha        string
	VPrefix    bool
}

type TagOrderBy

type TagOrderBy string

const (
	TagOrderAlphabetical TagOrderBy = "alphabetical"
	TagOrderCommitDate   TagOrderBy = "commit-date"
	TagOrderSemver       TagOrderBy = "semver"
)