git

Documentation

Index

• Variables
• func CloneRepository(url string, sshPrivateKey string)
• func GetRepo() *git.Repository
• func GetRepoDir() string
• func GetRepoHeadCommit() (*gitobject.Commit, error)
• func RefreshRepository() error

Variables

var ErrUpdatedTooRecently = errors.New("updated too recently")

Functions

func CloneRepository

func CloneRepository(url string, sshPrivateKey string)

func GetRepo

func GetRepo() *git.Repository

This function returns the current repository object

func GetRepoDir

func GetRepoDir() string

This function returns the current repository path as a string.

func GetRepoHeadCommit

func GetRepoHeadCommit() (*gitobject.Commit, error)

This function returns (*object.Commit, error). The Git Commit Object is the result of resolving HEAD on the config repository used by the scheduler.. see https://pkg.go.dev/github.com/go-git/go-git/v5@v5.1.0/plumbing/object?tab=doc#Commit Error is nil if OK.

func RefreshRepository

func RefreshRepository() error

This function refreshes the git Worktree containing the configuration of the scheduler. It's basically running the equivalent of 'git pull'.