git

Documentation

Overview

Package git contains git repo cloning functions similar to Kustomize's

Index

• func LookupCommit(repoPath string) (string, error)
• type RepoSpec
  • func (rs RepoSpec) AbsPath() string
  • func (rs *RepoSpec) CloneSpec() string
  • func (rs *RepoSpec) RepoRef() string

Functions

func LookupCommit

func LookupCommit(repoPath string) (string, error)

lookupCommit looks up the sha of the current commit on the repo at the provided path.

Types

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 string

	// Commit is the commit for the version that was added to Dir.
	Commit string

	// 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
}

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

func (RepoSpec) AbsPath

func (rs RepoSpec) AbsPath() string

AbsPath is the absolute path to the subdirectory

func (*RepoSpec) CloneSpec

func (rs *RepoSpec) CloneSpec() string

CloneSpec returns the string to pass to git to clone

func (*RepoSpec) RepoRef

func (rs *RepoSpec) RepoRef() string