git

README

Paketo Buildpack for Git

The Paketo Buildpack for Git is a Cloud Native Buildpack that retrieves git metadata and performs git operations.

Behavior

This buildpack uses the git dependency off of the stack that it is running on top of. The Git buildpack will only participate if there is a valid .git directory in the application source directory or if there a git-credentials service bindings present.

The buildpack will do the following:

• Sets the REVISION environment variable, which is the commitish of HEAD, to be available for the build processes of other buildpacks and in the final running image.
• Sets the org.opencontainers.image.revision label with the same commitish as the REVISION environment variable.
• Creates custom git credential managers if it is provided with credentials through a binding.

Bindings

The buildpack optionally accepts the following bindings:

Type: git-credentials

Key	Value	Description
credentials	<formated git credentials>	The credentials file should have the following format to conform with the git credential structure.
context (optional)	<url>	The context is an optional pattern as defined by git. If a context is not provided then the credentials given in the binding will be the default credentials that git uses when authenticating. A given context can only be used once for any group of bindings, if a context is given by two separate bindings the build will fail.

Documentation

Index

• Constants
• func Build(executable Executable, credentialManager CredentialManager, ...) packit.BuildFunc
• func Detect(bindingResolver BindingResolver) packit.DetectFunc
• type BindingResolver
• type CredentialManager
• type Executable
• type GitCredentialManager
  • func NewGitCredentialManager(bindingResolver BindingResolver, executable Executable, logs scribe.Emitter) GitCredentialManager
  • func (g GitCredentialManager) Setup(workingDir, platformDir string) error

Constants

const (
	// LayerNameGit is the name of the layer that is used to store git environment variables.
	LayerNameGit = "git"
)

Functions

func Build

func Build(executable Executable, credentialManager CredentialManager, logger scribe.Emitter) packit.BuildFunc

func Detect

func Detect(bindingResolver BindingResolver) packit.DetectFunc

Types

type BindingResolver

type BindingResolver interface {
	Resolve(typ, provider, platformDir string) ([]servicebindings.Binding, error)
}

type CredentialManager

type CredentialManager interface {
	Setup(workingDir, platformPath string) (err error)
}

type Executable

type Executable interface {
	Execute(pexec.Execution) (err error)
}

type GitCredentialManager

type GitCredentialManager struct {
	// contains filtered or unexported fields
}

func NewGitCredentialManager

func NewGitCredentialManager(bindingResolver BindingResolver, executable Executable, logs scribe.Emitter) GitCredentialManager

func (GitCredentialManager) Setup

func (g GitCredentialManager) Setup(workingDir, platformDir string) error