git

Documentation

Index

• Constants
• func CloneRepository(ctx context.Context, gitInfo *GitInfo, targetDir string, helper string, ...) error
• func CloneRepositoryWithEnv(ctx context.Context, gitInfo *GitInfo, extraEnv []string, targetDir string, ...) error
• func CommandContext(ctx context.Context, args ...string) *exec.Cmd
• func GetBranchNameForPR(ref string) string
• func GetIDForPR(ref string) string
• func InstallBinary(log log.Logger) error
• func NormalizeRepository(str string) (string, string, string, string, string)
• func PingRepository(str string) bool
• type CloneStrategy
  • func (s *CloneStrategy) Set(v string) error
  • func (s *CloneStrategy) String() string
  • func (s *CloneStrategy) Type() string
• type Cloner
  • func NewCloner(strategy CloneStrategy) Cloner
  • func NewClonerWithOpts(options ...Option) Cloner
• type GitInfo
  • func NewGitInfo(repository, branch, commit, pr, subpath string) *GitInfo
  • func NormalizeRepositoryGitInfo(str string) *GitInfo
• type Option
  • func WithCloneStrategy(strategy CloneStrategy) Option
  • func WithRecursiveSubmodules() Option

Constants

const (
	CommitDelimiter      string = "@sha256:"
	PullRequestReference string = "pull/([0-9]+)/head"
	SubPathDelimiter     string = "@subpath:"
)

Functions

func CloneRepository

func CloneRepository(ctx context.Context, gitInfo *GitInfo, targetDir string, helper string, cloner Cloner, log log.Logger) error

func CloneRepositoryWithEnv

func CloneRepositoryWithEnv(ctx context.Context, gitInfo *GitInfo, extraEnv []string, targetDir string, helper string, cloner Cloner, log log.Logger) error

func CommandContext

func CommandContext(ctx context.Context, args ...string) *exec.Cmd

func GetBranchNameForPR

func GetBranchNameForPR(ref string) string

func GetIDForPR

func GetIDForPR(ref string) string

func InstallBinary

func InstallBinary(log log.Logger) error

func NormalizeRepository

func NormalizeRepository(str string) (string, string, string, string, string)

func PingRepository

func PingRepository(str string) bool

Types

type CloneStrategy

type CloneStrategy string

const (
	FullCloneStrategy     CloneStrategy = ""
	BloblessCloneStrategy CloneStrategy = "blobless"
	TreelessCloneStrategy CloneStrategy = "treeless"
	ShallowCloneStrategy  CloneStrategy = "shallow"
	BareCloneStrategy     CloneStrategy = "bare"
)

func (*CloneStrategy) Set

func (s *CloneStrategy) Set(v string) error

func (*CloneStrategy) String

func (s *CloneStrategy) String() string

func (*CloneStrategy) Type

func (s *CloneStrategy) Type() string

type Cloner

type Cloner interface {
	Clone(ctx context.Context, repository string, targetDir string, extraArgs, extraEnv []string, log log.Logger) error
}

func NewCloner

func NewCloner(strategy CloneStrategy) Cloner

func NewClonerWithOpts

func NewClonerWithOpts(options ...Option) Cloner

type GitInfo

type GitInfo struct {
	Repository string
	Branch     string
	Commit     string
	PR         string
	SubPath    string
}

func NewGitInfo

func NewGitInfo(repository, branch, commit, pr, subpath string) *GitInfo

func NormalizeRepositoryGitInfo

func NormalizeRepositoryGitInfo(str string) *GitInfo

type Option

type Option func(*cloner)

func WithCloneStrategy

func WithCloneStrategy(strategy CloneStrategy) Option

func WithRecursiveSubmodules

func WithRecursiveSubmodules() Option