build

Documentation

Index

• func DependenciesForArtifact(ctx context.Context, a *latest.Artifact, cfg docker.Config, ...) ([]string, error)
• func TagWithDigest(tag, digest string) string
• func TagWithImageID(ctx context.Context, tag string, imageID string, ...) (string, error)
• type Artifact
  • func InOrder(ctx context.Context, out io.Writer, tags tag.ImageTags, ...) ([]Artifact, error)
  • func MergeWithPreviousBuilds(builds, previous []Artifact) []Artifact
• type ArtifactBuilder
  • func WithLogFile(builder ArtifactBuilder, muted Muted) ArtifactBuilder
• type ArtifactGraph
  • func ToArtifactGraph(artifacts []*latest.Artifact) ArtifactGraph
  • func (g ArtifactGraph) Dependencies(a *latest.Artifact) []*latest.Artifact
• type ArtifactStore
  • func NewArtifactStore() ArtifactStore
• type Builder
• type BuilderMux
  • func NewBuilderMux(cfg Config, store ArtifactStore, ...) (*BuilderMux, error)
  • func (b *BuilderMux) Build(ctx context.Context, out io.Writer, tags tag.ImageTags, ...) ([]Artifact, error)
  • func (b *BuilderMux) Prune(ctx context.Context, writer io.Writer) error
• type Config
• type ErrSyncMapNotSupported
  • func (ErrSyncMapNotSupported) Error() string
• type Muted
• type PipelineBuilder

Functions

func DependenciesForArtifact

func DependenciesForArtifact(ctx context.Context, a *latest.Artifact, cfg docker.Config, r docker.ArtifactResolver) ([]string, error)

DependenciesForArtifact returns the dependencies for a given artifact.

func TagWithDigest

func TagWithDigest(tag, digest string) string

func TagWithImageID

func TagWithImageID(ctx context.Context, tag string, imageID string, localDocker docker.LocalDaemon) (string, error)

Types

type Artifact

type Artifact struct {
	ImageName string `json:"imageName"`
	Tag       string `json:"tag"`
}

Artifact is the result corresponding to each successful build.

func InOrder

func InOrder(ctx context.Context, out io.Writer, tags tag.ImageTags, artifacts []*latest.Artifact, artifactBuilder ArtifactBuilder, concurrency int, store ArtifactStore) ([]Artifact, error)

InOrder builds a list of artifacts in dependency order.

func MergeWithPreviousBuilds

func MergeWithPreviousBuilds(builds, previous []Artifact) []Artifact

MergeWithPreviousBuilds merges previous or prebuilt build artifacts with builds. If an artifact is already present in builds, the same artifact from previous will be replaced at the same position.

type ArtifactBuilder

type ArtifactBuilder func(ctx context.Context, out io.Writer, artifact *latest.Artifact, tag string) (string, error)

func WithLogFile

func WithLogFile(builder ArtifactBuilder, muted Muted) ArtifactBuilder

WithLogFile wraps an `artifactBuilder` so that it optionally outputs its logs to a file.

type ArtifactGraph

type ArtifactGraph map[string]*latest.Artifact

ArtifactGraph is a map of [artifact image : artifact definition]

func ToArtifactGraph

func ToArtifactGraph(artifacts []*latest.Artifact) ArtifactGraph

ToArtifactGraph creates an instance of `ArtifactGraph` from `[]*latest.Artifact`

func (ArtifactGraph) Dependencies

func (g ArtifactGraph) Dependencies(a *latest.Artifact) []*latest.Artifact

Dependencies returns the de-referenced slice of required artifacts for a given artifact

type ArtifactStore

type ArtifactStore interface {
	Record(a *latest.Artifact, tag string)
	GetImageTag(imageName string) (tag string, found bool)
	GetArtifacts(s []*latest.Artifact) ([]Artifact, error)
}

ArtifactStore stores the results of each artifact build.

func NewArtifactStore

func NewArtifactStore() ArtifactStore

type Builder

type Builder interface {
	Build(ctx context.Context, out io.Writer, tags tag.ImageTags, artifacts []*latest.Artifact) ([]Artifact, error)

	// Prune removes images built with Skaffold
	Prune(context.Context, io.Writer) error
}

Builder is an interface to the Build API of Skaffold. It must build and make the resulting image accessible to the cluster. This could include pushing to a authorized repository or loading the nodes with the image. If artifacts is supplied, the builder should only rebuild those artifacts.

type BuilderMux

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

BuilderMux encapsulates multiple build configs.

func NewBuilderMux

func NewBuilderMux(cfg Config, store ArtifactStore, builder func(p latest.Pipeline) (PipelineBuilder, error)) (*BuilderMux, error)

NewBuilderMux returns an implementation of `build.BuilderMux`.

func (*BuilderMux) Build

func (b *BuilderMux) Build(ctx context.Context, out io.Writer, tags tag.ImageTags, artifacts []*latest.Artifact) ([]Artifact, error)

Build executes the specific image builder for each artifact in the given artifact slice.

func (*BuilderMux) Prune

func (b *BuilderMux) Prune(ctx context.Context, writer io.Writer) error

Prune removes built images.

type Config

type Config interface {
	GetPipelines() []latest.Pipeline
}

Config represents an interface for getting all config pipelines.

type ErrSyncMapNotSupported

type ErrSyncMapNotSupported struct{}

func (ErrSyncMapNotSupported) Error

func (ErrSyncMapNotSupported) Error() string

type Muted

type Muted interface {
	MuteBuild() bool
}

type PipelineBuilder

type PipelineBuilder interface {

	// PreBuild executes any one-time setup required prior to starting any build on this builder
	PreBuild(ctx context.Context, out io.Writer) error

	// Build returns the `ArtifactBuilder` based on this build pipeline type
	Build(ctx context.Context, out io.Writer, artifact *latest.Artifact) ArtifactBuilder

	// PostBuild executes any one-time teardown required after all builds on this builder are complete
	PostBuild(ctx context.Context, out io.Writer) error

	// Concurrency specifies the max number of builds that can run at any one time. If concurrency is 0, then all builds can run in parallel.
	Concurrency() int

	// Prune removes images built in this pipeline
	Prune(context.Context, io.Writer) error
}

PipelineBuilder is an interface for a specific Skaffold config pipeline build type. Current implementations are the `local`, `cluster` and `gcb`