git

Documentation

Index

• Constants
• Variables
• func CheckOnline(ctx context.Context) bool
• func CheckoutRef(repo *git.Repository, refName string) error
• func CloneExisting(_ context.Context, path, _ string) (*git.Repository, error)
• func CloneNonExisting(ctx context.Context, path, url string) (*git.Repository, error)
• func GetHash(repo *git.Repository, refName string) (*plumbing.Hash, error)
• func IsFatalError(err error) bool
• func IsGitRepo(path string) bool
• func IsPartOfGitRepo(path string) (string, bool)
• func IsWarningError(err error) bool
• func NewFatalError(message string) error
• func NewWarningError(message string) error
• func Open(ctx context.Context, path string, url, refName string, progressFn func(string)) (*git.Repository, *object.Commit, error)
• func Open2(ctx context.Context, path, url string) (*git.Repository, error)
• func ResolveToCommit(repo *git.Repository, refName string) (*object.Commit, error)
• type BranchName
  • func (b BranchName) BranchInLocal() plumbing.ReferenceName
  • func (b BranchName) BranchInRemote() plumbing.ReferenceName
• type FatalError
  • func (e *FatalError) Error() string
• type TagName
  • func (b TagName) TagInLocal() plumbing.ReferenceName
  • func (b TagName) TagInRemote() plumbing.ReferenceName
• type WarningError
  • func (e *WarningError) Error() string

Constants

const (
	//DefaultMainReferenceName plumbing.ReferenceName = "refs/heads/main"
	OriginName string     = "origin"
	MainBranch BranchName = "main"

	BranchPrefixInRemoteRepo = "refs/remotes/" + OriginName + "/"
	BranchPrefixInLocalRepo  = "refs/heads/"
	TagsPrefixInLocalRepo    = "refs/tags/"
	TagsPrefixInRemoteRepo   = "refs/tags/"
)

Variables

var (
	DefaultMainReferenceName plumbing.ReferenceName = plumbing.ReferenceName(BranchPrefixInLocalRepo + "/" + string(MainBranch))
)

Functions

func CheckOnline

func CheckOnline(ctx context.Context) bool

func CheckoutRef

func CheckoutRef(repo *git.Repository, refName string) error

CheckoutRef checks out a specific ref

func CloneExisting

func CloneExisting(_ context.Context, path, _ string) (*git.Repository, error)

func CloneNonExisting

func CloneNonExisting(ctx context.Context, path, url string) (*git.Repository, error)

func GetHash

func GetHash(repo *git.Repository, refName string) (*plumbing.Hash, error)

resolveToCommit takes a repository and a reference name (tag or commit hash) and resolves it to a commit object

func IsFatalError

func IsFatalError(err error) bool

func IsGitRepo

func IsGitRepo(path string) bool

func IsPartOfGitRepo

func IsPartOfGitRepo(path string) (string, bool)

IsPartOfGitRepo returns the path of the repo and a boolean to indicate if the path is part of a git repo

func IsWarningError

func IsWarningError(err error) bool

IsWarningError checks if the error is a WarningError.

func NewFatalError

func NewFatalError(message string) error

Convenience functions for creating errors

func NewWarningError

func NewWarningError(message string) error

func Open

func Open(ctx context.Context, path string, url, refName string, progressFn func(string)) (*git.Repository, *object.Commit, error)

Open open the git repo and either clones or fecthes the remote info

func Open2

func Open2(ctx context.Context, path, url string) (*git.Repository, error)

func ResolveToCommit

func ResolveToCommit(repo *git.Repository, refName string) (*object.Commit, error)

resolveToCommit takes a repository and a reference name (tag or commit hash) and resolves it to a commit object

Types

type BranchName

type BranchName string

BranchName represents a relative branch name (i.e. 'main', 'drafts/bucket/v1') and supports transformation to the ReferenceName in local (cached) repository (those references are in the form 'refs/remotes/origin/...') or in the remote repository (those references are in the form 'refs/heads/...').

func (BranchName) BranchInLocal

func (b BranchName) BranchInLocal() plumbing.ReferenceName

func (BranchName) BranchInRemote

func (b BranchName) BranchInRemote() plumbing.ReferenceName

type FatalError

type FatalError struct {
	Message string
}

func (*FatalError) Error

func (e *FatalError) Error() string

type TagName

type TagName string

func (TagName) TagInLocal

func (b TagName) TagInLocal() plumbing.ReferenceName

func (TagName) TagInRemote

func (b TagName) TagInRemote() plumbing.ReferenceName

type WarningError

type WarningError struct {
	Message string
}

WarningError represents non-critical errors that serve as warnings.

func (*WarningError) Error

func (e *WarningError) Error() string