git

Documentation

Index

• func ClonerUsingGitExec(repoSpec *RepoSpec) error
• type Cloner
  • func DoNothingCloner(dir filesys.ConfirmedDir) Cloner
• type RepoSpec
  • func NewRepoSpecFromURL(n string) (*RepoSpec, error)
  • func (x *RepoSpec) AbsPath() string
  • func (x *RepoSpec) Cleaner(fSys filesys.FileSystem) func() error
  • func (x *RepoSpec) CloneDir() filesys.ConfirmedDir
  • func (x *RepoSpec) CloneSpec() string
  • func (x *RepoSpec) Raw() string

Functions

func ClonerUsingGitExec

func ClonerUsingGitExec(repoSpec *RepoSpec) error

ClonerUsingGitExec uses a local git install, as opposed to say, some remote API, to obtain a local clone of a remote repo.

Types

type Cloner

type Cloner func(repoSpec *RepoSpec) error

Cloner is a function that can clone a git repo.

func DoNothingCloner

func DoNothingCloner(dir filesys.ConfirmedDir) Cloner

DoNothingCloner returns a cloner that only sets cloneDir field in the repoSpec. It's assumed that the cloneDir is associated with some fake filesystem used in a test.

type RepoSpec

type RepoSpec struct {

	// Host, e.g. github.com
	Host string

	// orgRepo name (organization/repoName),
	// e.g. kubernetes-sigs/kustomize
	OrgRepo string

	// Dir where the orgRepo is cloned to.
	Dir filesys.ConfirmedDir

	// Relative path in the repository, and in the cloneDir,
	// to a Kustomization.
	Path string

	// Branch or tag reference.
	Ref string

	// e.g. .git or empty in case of _git is present
	GitSuffix string

	// Submodules indicates whether or not to clone git submodules.
	Submodules bool

	// Timeout is the maximum duration allowed for execing git commands.
	Timeout time.Duration
	// contains filtered or unexported fields
}

RepoSpec specifies a git repository and a branch and path therein.

func NewRepoSpecFromURL

func NewRepoSpecFromURL(n string) (*RepoSpec, error)

NewRepoSpecFromURL parses git-like urls. From strings like git@github.com:someOrg/someRepo.git or https://github.com/someOrg/someRepo?ref=someHash, extract the parts.

func (*RepoSpec) AbsPath

func (x *RepoSpec) AbsPath() string

func (*RepoSpec) Cleaner

func (x *RepoSpec) Cleaner(fSys filesys.FileSystem) func() error

func (*RepoSpec) CloneDir

func (x *RepoSpec) CloneDir() filesys.ConfirmedDir

func (*RepoSpec) CloneSpec

func (x *RepoSpec) CloneSpec() string

CloneSpec returns a string suitable for "git clone {spec}".

func (*RepoSpec) Raw

func (x *RepoSpec) Raw() string