gitclone

Documentation

Index

• func RedactCredsInText(text string, urlStr string) (redactedText string, _ error)
• func RepoNameUsedInCacheDir(repoName, repoID string) string
• func TestClone(logger hclog.Logger, url string, tempDirRoot string) error
• type AccessDetails
• type CloneResults
  • func CloneWithCache(ctx context.Context, logger hclog.Logger, access AccessDetails, dirs Dirs, ...) (_ CloneResults, rerr error)
• type Dirs

Functions

func RedactCredsInText

func RedactCredsInText(text string, urlStr string) (redactedText string, _ error)

func RepoNameUsedInCacheDir

func RepoNameUsedInCacheDir(repoName, repoID string) string

func TestClone

func TestClone(logger hclog.Logger, url string, tempDirRoot string) error

TestClone tried to clone repo based on the url passed. If it fails returns an error. Does not do the full clone, exists after it confirms that remote is sending data.

Types

type AccessDetails

type AccessDetails struct {
	URL string
}

type CloneResults

type CloneResults struct {
	CacheDir string
	Checkout string
}

func CloneWithCache

func CloneWithCache(ctx context.Context, logger hclog.Logger, access AccessDetails, dirs Dirs, repoID string, name string) (_ CloneResults, rerr error)

CloneWithCache mirrors a provided repo into dirs.CacheRoot/name-repoID. And then checkout a copy into dirs.Checkout Automatically retries on errors.

type Dirs

type Dirs struct {
	CacheRoot string
}