git

Documentation

Index

• func Build(logger scribe.Logger) packit.BuildFunc
• func Detect(logger scribe.Logger) packit.DetectFunc
• type BuildEnvironment
  • func (e BuildEnvironment) Configure() error
  • func (e BuildEnvironment) Initialize() error
  • func (e BuildEnvironment) RunGitCommand(args []string) error
  • func (e BuildEnvironment) StoreCredentials() error
• type BuildPackYML
  • func BuildpackYMLParse(path string) (BuildPackYML, error)
• type Configuration
  • func ReadConfiguration(cnbPath string) (Configuration, error)
• type GitCredential
• type MetaData

Functions

func Build

func Build(logger scribe.Logger) packit.BuildFunc

Build executes the main functionality if this buildpack participates in the build plan

func Detect

func Detect(logger scribe.Logger) packit.DetectFunc

Detect determines whether this buildpack should participate

Types

type BuildEnvironment

type BuildEnvironment struct {
	BuildPackYML  BuildPackYML
	Configuration Configuration
	Context       packit.BuildContext
	Logger        scribe.Logger
}

BuildEnvironment represents a build environment for this buildpack

func (BuildEnvironment) Configure

func (e BuildEnvironment) Configure() error

Configure creates configuration to direct GIT to use the HTTPs protocol rather than the SSH protocol

func (BuildEnvironment) Initialize

func (e BuildEnvironment) Initialize() error

Initialize initalizes the GIT credential cache which stores credentials in memory exclusively

func (BuildEnvironment) RunGitCommand

func (e BuildEnvironment) RunGitCommand(args []string) error

RunGitCommand executes a GIT command with given arguments

func (BuildEnvironment) StoreCredentials

func (e BuildEnvironment) StoreCredentials() error

StoreCredentials runs "git credential approve" to add credentials to the GIT credential cache

type BuildPackYML

type BuildPackYML struct {
	Credentials []GitCredential `yaml:"credentials,omitempty"`
}

BuildPackYML represents the buildpack.yml file provided by a user / an app

func BuildpackYMLParse

func BuildpackYMLParse(path string) (BuildPackYML, error)

BuildpackYMLParse parses the buildpack.yml file

type Configuration

type Configuration struct {
	DefaultTimeout  string `toml:"default_timeout"`
	DefaultProcotol string `toml:"default_protocol"`
	DefaultHost     string `toml:"default_host"`
	DefaultPath     string `toml:"default_path"`
	DefaultURL      string `toml:"default_url"`
}

Configuration represents this buildpack's configuration read from a table named "configuration"

func ReadConfiguration

func ReadConfiguration(cnbPath string) (Configuration, error)

ReadConfiguration returns the configuration for this buildpack

type GitCredential

type GitCredential struct {
	Protocol string `yaml:"protocol"`
	Host     string `yaml:"host"`
	Path     string `yaml:"path"`
	Username string `yaml:"username"`
	Password string `yaml:"password"`
	URL      string `yaml:"url"`
}

GitCredential represents GIT credentials to be stored in the GIT credentials cache

type MetaData

type MetaData struct {
	Metadata struct {
		Configuration Configuration `toml:"configuration"`
	} `toml:"metadata"`
}

MetaData represents this buildpack's metadata