carton

Documentation

Index

• Constants
• func NetrcPath() (string, error)
• type BuildImageDependency
  • func (i BuildImageDependency) Update(options ...Option)
• type BuildpackDependency
  • func (b BuildpackDependency) Update(options ...Option)
• type Config
• type EntryWriter
• type LifecycleDependency
  • func (l LifecycleDependency) Update(options ...Option)
• type Netrc
  • func ParseNetrc(path string) (Netrc, error)
  • func (n Netrc) BasicAuth(request *http.Request) (*http.Request, error)
• type NetrcLine
• type Option
  • func WithEntryWriter(entryWriter EntryWriter) Option
  • func WithExecutor(executor effect.Executor) Option
  • func WithExitHandler(exitHandler libcnb.ExitHandler) Option
• type Package
  • func (p Package) Create(options ...Option)
• type PackageDependency
  • func (p PackageDependency) Update(options ...Option)

Constants

const (
	ImageDependencyPattern      = `(?m)(.*build-image[\s]+=[\s]+"[^"]+:)[^"]+(".*)`
	ImageDependencySubstitution = "${1}%s${2}"
)

const (
	BuildpackDependencyPattern      = `(?m)([\s]*.*id[\s]+=[\s]+"%s"\n.*\n[\s]*version[\s]+=[\s]+")%s("\n[\s]*uri[\s]+=[\s]+").*("\n[\s]*sha256[\s]+=[\s]+").*(".*)`
	BuildpackDependencySubstitution = "${1}%s${2}%s${3}%s${4}"
)

const (
	LifecycleDependencyPattern      = `(?m)(.*\[lifecycle\]\nuri[\s]+=[\s]+")[^"]+(".*)`
	LifecycleDependencySubstitution = "${1}https://github.com/buildpacks/lifecycle/releases/download/v%[1]s/lifecycle-v%[1]s+linux.x86-64.tgz${2}"
)

const DefaultTargetArch = "all"

Functions

func NetrcPath

func NetrcPath() (string, error)

Types

type BuildImageDependency

type BuildImageDependency struct {
	BuilderPath string
	Version     string
}

func (BuildImageDependency) Update

func (i BuildImageDependency) Update(options ...Option)

type BuildpackDependency

type BuildpackDependency struct {
	BuildpackPath  string
	ID             string
	Arch           string
	SHA256         string
	URI            string
	Version        string
	VersionPattern string
	CPE            string
	CPEPattern     string
	PURL           string
	PURLPattern    string
	Source         string `toml:"source,omitempty"`
	SourceSHA256   string `toml:"source-sha256,omitempty"`
}

func (BuildpackDependency) Update

func (b BuildpackDependency) Update(options ...Option)

type Config

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

Config is an object that contains configurable properties for execution.

type EntryWriter

type EntryWriter interface {

	// Write reads a file from source and writes it to the relative path destination.
	Write(source string, destination string) error
}

EntryWriter is the interface implemented by a type that wants to write an entry.

type LifecycleDependency

type LifecycleDependency struct {
	BuilderPath string
	Version     string
}

func (LifecycleDependency) Update

func (l LifecycleDependency) Update(options ...Option)

type Netrc

type Netrc []NetrcLine

func ParseNetrc

func ParseNetrc(path string) (Netrc, error)

func (Netrc) BasicAuth

func (n Netrc) BasicAuth(request *http.Request) (*http.Request, error)

type NetrcLine

type NetrcLine struct {
	Machine  string
	Login    string
	Password string
}

type Option

type Option func(config Config) Config

Option is a function for configuring a Config instance.

func WithEntryWriter

func WithEntryWriter(entryWriter EntryWriter) Option

WithEntryWriter creates an Option that sets an EntryWriter implementation.

func WithExecutor

func WithExecutor(executor effect.Executor) Option

WithExecutor creates an Option that sets an Executor implementation.

func WithExitHandler

func WithExitHandler(exitHandler libcnb.ExitHandler) Option

WithExitHandler creates an Option that sets an ExitHandler implementation.

type Package

type Package struct {

	// CacheLocation is the location to cache downloaded dependencies.
	CacheLocation string

	// DependencyFilters indicates which filters should be applied to exclude dependencies
	DependencyFilters []string

	// StrictDependencyFilters indicates that a filter must match both the ID and version, otherwise it must only match one of the two
	StrictDependencyFilters bool

	// IncludeDependencies indicates whether to include dependencies in build package.
	IncludeDependencies bool

	// Destination is the directory to create the build package in.
	Destination string

	// Source is the source directory of the buildpack.
	Source string

	// Version is a version to substitute into an existing buildpack.toml.
	Version string

	// TargetArch is the target architecture to package. Default is "all".
	TargetArch string
}

Package is an object that contains the configuration for building a package.

func (Package) Create

func (p Package) Create(options ...Option)

Create creates a package.

type PackageDependency

type PackageDependency struct {
	BuilderPath   string
	BuildpackPath string
	ID            string
	Version       string
	PackagePath   string
}

func (PackageDependency) Update

func (p PackageDependency) Update(options ...Option)