git

Documentation

Index

• func CheckoutCommit(target string, commit string) error
• func CheckoutTag(target, name string) error
• func Clone(src string, dst string) error
• func CloneOrPull(src string, dst string) error
• func GetTagsFromRemote(remote *git.Remote) (VersionInfo, VersionCollection, error)
• func GetTagsFromRepo(source string) (VersionInfo, VersionCollection, error)
• func IsValidGitUrl(url string) bool
• func ParseAsUrl(url string) (*url.URL, error)
• func ParseAsVcsUrl(url string) (*vcsurl.VCS, error)
• func Pull(dst string) error
• func SortRepoInfo(infos []*RepoInfo)
• type RepoInfo
  • func LocalRepoInfo(source string) (*RepoInfo, error)
  • func RemoteRepoInfo(url string) (*RepoInfo, error)
  • func (r *RepoInfo) FQN() string
  • func (r *RepoInfo) VersionName() string
• type VersionCollection
  • func (c VersionCollection) AsList() []string
  • func (c VersionCollection) Latest() VersionInfo
  • func (c VersionCollection) Len() int
  • func (c VersionCollection) Less(i, j int) bool
  • func (c VersionCollection) String() string
  • func (c VersionCollection) Swap(i, j int)
• type VersionInfo

Functions

func CheckoutCommit

func CheckoutCommit(target string, commit string) error

func CheckoutTag

func CheckoutTag(target, name string) error

func Clone

func Clone(src string, dst string) error

func CloneOrPull

func CloneOrPull(src string, dst string) error

func GetTagsFromRemote

func GetTagsFromRemote(remote *git.Remote) (VersionInfo, VersionCollection, error)

GetLatestTagFromRepo returns the latest tag and a list of all tags from a repo

func GetTagsFromRepo

func GetTagsFromRepo(source string) (VersionInfo, VersionCollection, error)

func IsValidGitUrl

func IsValidGitUrl(url string) bool

func ParseAsUrl

func ParseAsUrl(url string) (*url.URL, error)

func ParseAsVcsUrl

func ParseAsVcsUrl(url string) (*vcsurl.VCS, error)

func Pull

func Pull(dst string) error

func SortRepoInfo

func SortRepoInfo(infos []*RepoInfo)

Types

type RepoInfo

type RepoInfo struct {
	Name        string            `json:"name"`
	Description string            `json:"description"`
	Author      string            `json:"author"`
	Path        string            `json:"path"`
	Git         string            `json:"git"`
	Commit      string            `json:"commit"`
	Version     VersionInfo       `json:"version"`
	Latest      VersionInfo       `json:"latest"`
	Versions    VersionCollection `json:"versions"`
	InCache     bool              `json:"inCache"`
	InRegistry  bool              `json:"inRegistry"`
}

func LocalRepoInfo

func LocalRepoInfo(source string) (*RepoInfo, error)

func RemoteRepoInfo

func RemoteRepoInfo(url string) (*RepoInfo, error)

func (*RepoInfo) FQN

func (r *RepoInfo) FQN() string

func (*RepoInfo) VersionName

func (r *RepoInfo) VersionName() string

type VersionCollection

type VersionCollection []VersionInfo

VersionCollection is a collection of tags it implements sort.Interface

func (VersionCollection) AsList

func (c VersionCollection) AsList() []string

func (VersionCollection) Latest

func (c VersionCollection) Latest() VersionInfo

Latest returns the latest tag info

func (VersionCollection) Len

func (c VersionCollection) Len() int

Len is the number of elements in the collection.

func (VersionCollection) Less

func (c VersionCollection) Less(i, j int) bool

Less reports whether the element with index i should sort before the element with index j.

func (VersionCollection) String

func (c VersionCollection) String() string

func (VersionCollection) Swap

func (c VersionCollection) Swap(i, j int)

Swap swaps the elements with indexes i and j.

type VersionInfo

type VersionInfo struct {
	Name    string          `json:"name"`
	SHA     string          `json:"sha"`
	Version *semver.Version `json:"version"`
}

VersionInfo contains information about a tag