internal

Documentation

Index

• func OverwriteBuilderConfig(path string, config BuilderConfig) error
• func OverwriteBuildpackConfig(path string, config BuildpackConfig) error
• func OverwritePackageConfig(path string, config PackageConfig) error
• type BuilderConfig
  • func ParseBuilderConfig(path string) (BuilderConfig, error)
• type BuilderConfigBuildpack
  • func (b *BuilderConfigBuildpack) UnmarshalTOML(v interface{}) error
• type BuilderConfigLifecycle
• type BuilderConfigOrder
• type BuilderConfigOrderGroup
• type BuilderConfigStack
• type BuildpackConfig
  • func ParseBuildpackConfig(path string) (BuildpackConfig, error)
• type BuildpackConfigOrder
• type BuildpackConfigOrderGroup
• type BuildpackInspector
  • func NewBuildpackInspector() BuildpackInspector
  • func (i BuildpackInspector) Dependencies(path string) ([]cargo.Config, error)
• type DependencyCacher
  • func NewDependencyCacher(downloader Downloader, logger scribe.Logger) DependencyCacher
  • func (dc DependencyCacher) Cache(root string, deps []cargo.ConfigMetadataDependency) ([]cargo.ConfigMetadataDependency, error)
• type Downloader
• type Executable
• type File
• type FileBundler
  • func NewFileBundler() FileBundler
  • func (b FileBundler) Bundle(root string, paths []string, config cargo.Config) ([]File, error)
• type FileInfo
  • func NewFileInfo(name string, size int, mode os.FileMode, mtime time.Time) FileInfo
  • func (fi FileInfo) IsDir() bool
  • func (fi FileInfo) ModTime() time.Time
  • func (fi FileInfo) Mode() os.FileMode
  • func (fi FileInfo) Name() string
  • func (fi FileInfo) Size() int64
  • func (fi FileInfo) Sys() interface{}
• type Formatter
  • func NewFormatter(writer io.Writer) Formatter
  • func (f Formatter) JSON(configs []cargo.Config)
  • func (f Formatter) Markdown(configs []cargo.Config)
• type Image
  • func FindLatestBuildImage(runURI, buildURI string) (Image, error)
  • func FindLatestImage(uri string) (Image, error)
• type PackageConfig
  • func ParsePackageConfig(path string) (PackageConfig, error)
• type PackageConfigDependency
  • func (d *PackageConfigDependency) UnmarshalTOML(v interface{}) error
• type PrePackager
  • func NewPrePackager(executable Executable, logger scribe.Logger, output io.Writer) PrePackager
  • func (p PrePackager) Execute(scriptPath, rootDir string) error
• type TarBuilder
  • func NewTarBuilder(logger scribe.Logger) TarBuilder
  • func (b TarBuilder) Build(path string, files []File) error

Functions

func OverwriteBuilderConfig

func OverwriteBuilderConfig(path string, config BuilderConfig) error

func OverwriteBuildpackConfig

func OverwriteBuildpackConfig(path string, config BuildpackConfig) error

func OverwritePackageConfig

func OverwritePackageConfig(path string, config PackageConfig) error

Types

type BuilderConfig

type BuilderConfig struct {
	Description string                   `toml:"description"`
	Buildpacks  []BuilderConfigBuildpack `toml:"buildpacks"`
	Lifecycle   BuilderConfigLifecycle   `toml:"lifecycle"`
	Order       []BuilderConfigOrder     `toml:"order"`
	Stack       BuilderConfigStack       `toml:"stack"`
}

func ParseBuilderConfig

func ParseBuilderConfig(path string) (BuilderConfig, error)

type BuilderConfigBuildpack

type BuilderConfigBuildpack struct {
	URI     string `toml:"uri"`
	Version string `toml:"version"`
}

func (*BuilderConfigBuildpack) UnmarshalTOML

func (b *BuilderConfigBuildpack) UnmarshalTOML(v interface{}) error

Note: this is to support that buildpackages can refer to this field as `image` or `uri`.

type BuilderConfigLifecycle

type BuilderConfigLifecycle struct {
	Version string `toml:"version"`
}

type BuilderConfigOrder

type BuilderConfigOrder struct {
	Group []BuilderConfigOrderGroup `toml:"group"`
}

type BuilderConfigOrderGroup

type BuilderConfigOrderGroup struct {
	ID      string `toml:"id"`
	Version string `toml:"version"`
}

type BuilderConfigStack

type BuilderConfigStack struct {
	ID              string   `toml:"id"`
	BuildImage      string   `toml:"build-image"`
	RunImage        string   `toml:"run-image"`
	RunImageMirrors []string `toml:"run-image-mirrors"`
}

type BuildpackConfig

type BuildpackConfig struct {
	API       interface{}            `toml:"api"`
	Buildpack interface{}            `toml:"buildpack"`
	Metadata  interface{}            `toml:"metadata"`
	Order     []BuildpackConfigOrder `toml:"order"`
}

func ParseBuildpackConfig

func ParseBuildpackConfig(path string) (BuildpackConfig, error)

type BuildpackConfigOrder

type BuildpackConfigOrder struct {
	Group []BuildpackConfigOrderGroup `toml:"group"`
}

type BuildpackConfigOrderGroup

type BuildpackConfigOrderGroup struct {
	ID       string `toml:"id"`
	Version  string `toml:"version"`
	Optional bool   `toml:"optional,omitempty"`
}

type BuildpackInspector

type BuildpackInspector struct{}

func NewBuildpackInspector

func NewBuildpackInspector() BuildpackInspector

func (BuildpackInspector) Dependencies

func (i BuildpackInspector) Dependencies(path string) ([]cargo.Config, error)

type DependencyCacher

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

func NewDependencyCacher

func NewDependencyCacher(downloader Downloader, logger scribe.Logger) DependencyCacher

func (DependencyCacher) Cache

func (dc DependencyCacher) Cache(root string, deps []cargo.ConfigMetadataDependency) ([]cargo.ConfigMetadataDependency, error)

type Downloader

type Downloader interface {
	Drop(root, uri string) (io.ReadCloser, error)
}

type Executable

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

type File

type File struct {
	io.ReadCloser

	Name string
	Info os.FileInfo
	Link string
}

type FileBundler

type FileBundler struct{}

func NewFileBundler

func NewFileBundler() FileBundler

func (FileBundler) Bundle

func (b FileBundler) Bundle(root string, paths []string, config cargo.Config) ([]File, error)

type FileInfo

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

func NewFileInfo

func NewFileInfo(name string, size int, mode os.FileMode, mtime time.Time) FileInfo

func (FileInfo) IsDir

func (fi FileInfo) IsDir() bool

func (FileInfo) ModTime

func (fi FileInfo) ModTime() time.Time

func (FileInfo) Mode

func (fi FileInfo) Mode() os.FileMode

func (FileInfo) Name

func (fi FileInfo) Name() string

func (FileInfo) Size

func (fi FileInfo) Size() int64

func (FileInfo) Sys

func (fi FileInfo) Sys() interface{}

type Formatter

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

func NewFormatter

func NewFormatter(writer io.Writer) Formatter

func (Formatter) JSON

func (f Formatter) JSON(configs []cargo.Config)

func (Formatter) Markdown

func (f Formatter) Markdown(configs []cargo.Config)

type Image

type Image struct {
	Name    string
	Path    string
	Version string
}

func FindLatestBuildImage

func FindLatestBuildImage(runURI, buildURI string) (Image, error)

func FindLatestImage

func FindLatestImage(uri string) (Image, error)

type PackageConfig

type PackageConfig struct {
	Buildpack    interface{}               `toml:"buildpack"`
	Dependencies []PackageConfigDependency `toml:"dependencies"`
}

func ParsePackageConfig

func ParsePackageConfig(path string) (PackageConfig, error)

type PackageConfigDependency

type PackageConfigDependency struct {
	URI string `toml:"uri"`
}

func (*PackageConfigDependency) UnmarshalTOML

func (d *PackageConfigDependency) UnmarshalTOML(v interface{}) error

Note: this is to support that buildpackages can refer to this field as `image` or `uri`.

type PrePackager

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

func NewPrePackager

func NewPrePackager(executable Executable, logger scribe.Logger, output io.Writer) PrePackager

func (PrePackager) Execute

func (p PrePackager) Execute(scriptPath, rootDir string) error

type TarBuilder

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

func NewTarBuilder

func NewTarBuilder(logger scribe.Logger) TarBuilder

func (TarBuilder) Build

func (b TarBuilder) Build(path string, files []File) error