clone

Documentation

Index

• func FormatRecord(record Record) string
• func PathForRefs(baseDir string, refs *kube.Refs) string
• type Command
• type Record
  • func Run(refs *kube.Refs, dir, gitUserName, gitUserEmail string, env []string) Record

Functions

func FormatRecord

func FormatRecord(record Record) string

FormatRecord describes the record in a human-readable manner for inclusion into build logs

func PathForRefs

func PathForRefs(baseDir string, refs *kube.Refs) string

PathForRefs determines the full path to where refs should be cloned

Types

type Command

type Command struct {
	Command string `json:"command"`
	Output  string `json:"output,omitempty"`
	Error   string `json:"error,omitempty"`
}

Command is a trace of a command executed while achieving the desired git state.

type Record

type Record struct {
	Refs     *kube.Refs `json:"refs"`
	Commands []Command  `json:"commands"`
	Failed   bool       `json:"failed"`
}

Record is a trace of what the desired git state was, what steps we took to get there, and whether or not we were successful.

func Run

func Run(refs *kube.Refs, dir, gitUserName, gitUserEmail string, env []string) Record

Run clones the refs under the prescribed directory and optionally configures the git username and email in the repository as well.