Documentation
¶
Overview ¶
Package scl is an abstraction layer on top of the go-git library.
The 'GlifRepo' object is the struct that encloses the *git.Repository. It also contains maps and slices of tags object used to perform the diffs.
Some of these function are called from the builtins of the interpreter, tying the .gs scripts to this struct.
Index ¶
- type GlifRepo
- func (glifRepo *GlifRepo) Fetch()
- func (glifRepo *GlifRepo) FetchAllMatchingTags(regexString string) bool
- func (glifRepo *GlifRepo) GetLatestTag(offset int64) *object.Tag
- func (glifRepo *GlifRepo) GetSpecificTag(tagName string) *object.Tag
- func (glifRepo *GlifRepo) InitHeadRef()
- func (glifRepo *GlifRepo) Open(repoLoc string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GlifRepo ¶
type GlifRepo struct {
Params configuration.GlifParameters
HeadRef *plumbing.Reference
GitRepo *git.Repository
// contains filtered or unexported fields
}
GlifRepo is an abstraction on top of the *git.Repository to allow extended functionnality.
func (*GlifRepo) Fetch ¶
func (glifRepo *GlifRepo) Fetch()
Fetch does a 'Fetch' on the *git.Repository.
func (*GlifRepo) FetchAllMatchingTags ¶
FetchAllMatchingTags uses a regex to match tags (by name) in the git repository. Used in the following builtin(s):
- extractTags
func (*GlifRepo) GetLatestTag ¶
GetLatestTag returns the appropriate *object.Tag that correspond to the specified offset. GetLatestTag(0) would return the very latest tag because it would return the first index of the slice 'tagsLatestToEarliest' Used in the following builtin(s):
- getLatestTag
func (*GlifRepo) GetSpecificTag ¶
GetSpecificTag returns the appropriate *object.Tag that correspond to the specified name
func (*GlifRepo) InitHeadRef ¶
func (glifRepo *GlifRepo) InitHeadRef()
InitHeadRef does a 'Head' on the *git.Repository. This will return a *plumbing.Reference corresponding to the git 'HEAD' reference.
Source Files