buildpacks

Documentation

Index

• Variables
• func GetDependencies(ctx context.Context, workspace string, a *latestV1.BuildpackArtifact) ([]string, error)
• func GetEnv(a *latestV1.Artifact, mode config.RunMode) (map[string]string, error)
• func NewLogger(out io.Writer) logging.Logger
• func SyncRules(labels map[string]string) ([]*latestV1.SyncRule, error)
• type ArtifactConfig
  • func (c ArtifactConfig) ArtifactType(_ string) latestV1.ArtifactType
  • func (c ArtifactConfig) ConfiguredImage() string
  • func (c ArtifactConfig) Describe() string
  • func (c ArtifactConfig) Name() string
  • func (c ArtifactConfig) Path() string
• type ArtifactResolver
• type Builder
  • func NewArtifactBuilder(localDocker docker.LocalDaemon, pushImages bool, mode config.RunMode, ...) *Builder
  • func (b *Builder) Build(ctx context.Context, out io.Writer, artifact *latestV1.Artifact, tag string, ...) (string, error)
  • func (b *Builder) SupportedPlatforms() platform.Matcher

Variables

var Name = "Buildpacks"

Name is the name of the Buildpack builder

var (
	Validate = validate
)

For testing

Functions

func GetDependencies

func GetDependencies(ctx context.Context, workspace string, a *latestV1.BuildpackArtifact) ([]string, error)

GetDependencies returns dependencies listed for a buildpack artifact

func GetEnv

func GetEnv(a *latestV1.Artifact, mode config.RunMode) (map[string]string, error)

func NewLogger

func NewLogger(out io.Writer) logging.Logger

func SyncRules

func SyncRules(labels map[string]string) ([]*latestV1.SyncRule, error)

$ docker inspect demo/buildpacks | jq -r '.[].Config.Labels["io.buildpacks.build.metadata"] | fromjson.bom[].metadata["devmode.sync"]'

Types

type ArtifactConfig

type ArtifactConfig struct {
	File    string `json:"path,omitempty"`
	Builder string `json:"builder,omitempty"`
}

ArtifactConfig holds information about a Buildpack project

func (ArtifactConfig) ArtifactType

func (c ArtifactConfig) ArtifactType(_ string) latestV1.ArtifactType

ArtifactType returns the type of the artifact to be built.

func (ArtifactConfig) ConfiguredImage

func (c ArtifactConfig) ConfiguredImage() string

ConfiguredImage returns the target image configured by the builder, or empty string if no image is configured

func (ArtifactConfig) Describe

func (c ArtifactConfig) Describe() string

Describe returns the initBuilder's string representation, used when prompting the user to choose a builder.

func (ArtifactConfig) Name

func (c ArtifactConfig) Name() string

Name returns the name of the builder

func (ArtifactConfig) Path

func (c ArtifactConfig) Path() string

Path returns the path to the build definition

type ArtifactResolver

type ArtifactResolver interface {
	GetImageTag(imageName string) (string, bool)
}

ArtifactResolver provides an interface to resolve built artifact tags by image name.

type Builder

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

Builder is an artifact builder that uses buildpacks

func NewArtifactBuilder

func NewArtifactBuilder(localDocker docker.LocalDaemon, pushImages bool, mode config.RunMode, r ArtifactResolver) *Builder

NewArtifactBuilder returns a new buildpack artifact builder

func (*Builder) Build

func (b *Builder) Build(ctx context.Context, out io.Writer, artifact *latestV1.Artifact, tag string, matcher platform.Matcher) (string, error)

Build builds an artifact with Cloud Native Buildpacks: https://buildpacks.io/

func (*Builder) SupportedPlatforms

func (b *Builder) SupportedPlatforms() platform.Matcher