gt

README

gt

GT: Git Tools - assortment of useful functions dealing with Git repositories

Documentation

Index

• Variables
• type GitRepo
  • func New(repoURL, branchName, repoPath string) (*GitRepo, error)
  • func (gr *GitRepo) Clone() error
  • func (gr *GitRepo) CloneOptions() *git.CloneOptions
  • func (gr *GitRepo) CloneOrPull() error
  • func (gr *GitRepo) EnsurePath() error
  • func (gr *GitRepo) LatestSHA(length int) string
  • func (gr *GitRepo) Open()
  • func (gr *GitRepo) Pull() error
  • func (gr *GitRepo) PullOptions() *git.PullOptions
  • func (gr *GitRepo) ReferenceName() plumbing.ReferenceName
  • func (gr *GitRepo) RevisionExists(revName string) bool
  • func (gr *GitRepo) SetKeys(privateKey []byte) error
  • func (gr GitRepo) Worktree() *git.Worktree

Variables

var Logger zerolog.Logger

Types

type GitRepo

type GitRepo struct {
	URL        string
	Path       string
	BranchName string
	Repo       *git.Repository
	PublicKeys *gitssh.PublicKeys
}

func New

func New(repoURL, branchName, repoPath string) (*GitRepo, error)

func (*GitRepo) Clone

func (gr *GitRepo) Clone() error

func (*GitRepo) CloneOptions

func (gr *GitRepo) CloneOptions() *git.CloneOptions

func (*GitRepo) CloneOrPull

func (gr *GitRepo) CloneOrPull() error

func (*GitRepo) EnsurePath

func (gr *GitRepo) EnsurePath() error

func (*GitRepo) LatestSHA

func (gr *GitRepo) LatestSHA(length int) string

func (*GitRepo) Open

func (gr *GitRepo) Open()

func (*GitRepo) Pull

func (gr *GitRepo) Pull() error

func (*GitRepo) PullOptions

func (gr *GitRepo) PullOptions() *git.PullOptions

func (*GitRepo) ReferenceName

func (gr *GitRepo) ReferenceName() plumbing.ReferenceName

func (*GitRepo) RevisionExists

func (gr *GitRepo) RevisionExists(revName string) bool

func (*GitRepo) SetKeys

func (gr *GitRepo) SetKeys(privateKey []byte) error

func (GitRepo) Worktree

func (gr GitRepo) Worktree() *git.Worktree