carton

Documentation

Index

• Constants
• type Config
• type Dependency
  • func (d Dependency) Build(options ...Option)
• type EntryWriter
• type Option
  • func WithEntryWriter(entryWriter EntryWriter) Option
  • func WithExecutor(executor effect.Executor) Option
  • func WithExitHandler(exitHandler libcnb.ExitHandler) Option
• type Package
  • func (p Package) Build(options ...Option)

Constants

const (
	DependencyPattern      = `(?m)(.*id[\s]+=[\s]+"%s"\n.*\nversion[\s]+=[\s]+")%s("\nuri[\s]+=[\s]+").*("\nsha256[\s]+=[\s]+").*(".*)`
	DependencySubstitution = "${1}%s${2}%s${3}%s${4}"
)

Types

type Config

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

Config is an object that contains configurable properties for execution.

type Dependency

type Dependency struct {
	BuildpackPath  string
	ID             string
	SHA256         string
	URI            string
	Version        string
	VersionPattern string
}

func (Dependency) Build

func (d Dependency) Build(options ...Option)

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

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

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

func (Package) Build

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

Build creates a package.