git

Documentation

Index

• Variables
• func Clone(ctx context.Context, input GitCloneConfig) error
• func CloneIfRequired(ctx context.Context, refName plumbing.ReferenceName, input GitCloneConfig, ...) (*git.Repository, error)
• func FindGitRef(ctx context.Context, file string) (string, error)
• func FindGitRevision(ctx context.Context, file string) (shortSha string, sha string, err error)
• func FindGithubRepo(ctx context.Context, file, githubInstance, remoteName string) (string, error)
• type Error
  • func (e *Error) Commit() string
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
• type GitCloneConfig

Variables

var (
	ErrShortRef = errors.New("short SHA references are not supported")
	ErrNoRepo   = errors.New("unable to find git repo")
)

Functions

func Clone

func Clone(ctx context.Context, input GitCloneConfig) error

NewGitCloneExecutor creates an executor to clone git repos

func CloneIfRequired

func CloneIfRequired(ctx context.Context, refName plumbing.ReferenceName, input GitCloneConfig, lg *common.LoggerWrapper) (*git.Repository, error)

CloneIfRequired ...

func FindGitRef

func FindGitRef(ctx context.Context, file string) (string, error)

FindGitRef get the current git ref

func FindGitRevision

func FindGitRevision(ctx context.Context, file string) (shortSha string, sha string, err error)

FindGitRevision get the current git revision

func FindGithubRepo

func FindGithubRepo(ctx context.Context, file, githubInstance, remoteName string) (string, error)

FindGithubRepo get the repo

Types

type Error

type Error struct {
	// contains filtered or unexported fields
}

func (*Error) Commit

func (e *Error) Commit() string

func (*Error) Error

func (e *Error) Error() string

func (*Error) Unwrap

func (e *Error) Unwrap() error

type GitCloneConfig

type GitCloneConfig struct {
	URL   string
	Ref   string
	Dir   string
	Token string
}