vcsrepository

Documentation

Index

• func CollectGitRepositoryInformation(dir string, data map[string]string) (map[string]string, error)
• func FindGitReference(refType string, refName string) string
• func FindRepositoryDirectory(currentDirectory string) string
• func GetReferenceByName(projectDirectory string, refType string, refName string) (string, error)
• func GetVCSRepositoryInformation(dir string) (map[string]string, error)
• func GetVCSRepositoryType(dir string) string
• func IsGitRepository(directory string) bool
• type Commit
  • func FindCommitsBetweenRefs(dir string, startRef string, endRef string) ([]Commit, error)
  • func FindGitCommitsBetweenRefs(projectDir string, from string, to string) ([]Commit, error)
• type CommitAuthor
• type CommitTag
• type Release
  • func FindLatestGitRelease(projectDir string, from string, stable bool, skipFrom bool) (Release, error)
  • func FindLatestRelease(dir string, startAtReference string, stable bool, skipFrom bool) (Release, error)

Functions

func CollectGitRepositoryInformation

func CollectGitRepositoryInformation(dir string, data map[string]string) (map[string]string, error)

CollectGitRepositoryInformation retrieves normalized variables of the git repository

func FindGitReference

func FindGitReference(refType string, refName string) string

FindGitReference returns the unique reference

func FindRepositoryDirectory

func FindRepositoryDirectory(currentDirectory string) string

func GetReferenceByName

func GetReferenceByName(projectDirectory string, refType string, refName string) (string, error)

GetReferenceByName returns a unique identifier for a refType (tag, branch) / reFName (branch name / tag name)

func GetVCSRepositoryInformation

func GetVCSRepositoryInformation(dir string) (map[string]string, error)

GetVCSRepositoryInformation detects the repository type and gathers normalized information from the repository

func GetVCSRepositoryType

func GetVCSRepositoryType(dir string) string

GetVCSRepositoryType returns a short name of the repository type inside the directory (git, svn, unknown)

func IsGitRepository

func IsGitRepository(directory string) bool

IsGitRepository checks if the target directory contains a git repository

Types

type Commit

type Commit struct {
	ShortHash   string
	Hash        string
	Message     string
	Description string
	Author      CommitAuthor
	Committer   CommitAuthor
	Tags        []CommitTag
	AuthoredAt  time.Time
	CommittedAt time.Time
	Context     map[string]string
}

func FindCommitsBetweenRefs

func FindCommitsBetweenRefs(dir string, startRef string, endRef string) ([]Commit, error)

FindCommitsBetweenRefs finds all git commits between two references

func FindGitCommitsBetweenRefs

func FindGitCommitsBetweenRefs(projectDir string, from string, to string) ([]Commit, error)

FindGitCommitsBetweenRefs finds all git commits between two references, get references via FindGitReference

type CommitAuthor

type CommitAuthor struct {
	Name  string
	Email string
}

type CommitTag

type CommitTag struct {
	Name   string
	VCSRef string
}

type Release

type Release struct {
	Name      string
	Reference string
}

func FindLatestGitRelease

func FindLatestGitRelease(projectDir string, from string, stable bool, skipFrom bool) (Release, error)

func FindLatestRelease

func FindLatestRelease(dir string, startAtReference string, stable bool, skipFrom bool) (Release, error)

FindLatestRelease will retrieve the latest release version in the current branch