Documentation ¶
Index ¶
- Constants
- func CreateMultiPlatformImage(ctx context.Context, out io.Writer, a *latest.Artifact, tag string, ...) (string, error)
- func InOrder(ctx context.Context, out io.Writer, tags tag.ImageTags, ...) ([]graph.Artifact, error)
- func MergeWithPreviousBuilds(builds, previous []graph.Artifact) []graph.Artifact
- func SupportsMultiPlatformBuild(a latest.Artifact) bool
- func TagWithDigest(tag, digest string) string
- func TagWithImageID(ctx context.Context, tag string, imageID string, ...) (string, error)
- type ArtifactBuilder
- type ArtifactStore
- type Builder
- type BuilderMux
- type Cache
- type Config
- type ErrCustomBuildNoDockerfile
- type ErrSyncMapNotSupported
- type Muted
- type PipelineBuilder
Constants ¶
const (
PushImageErr = "could not push image"
)
Variables ¶
This section is empty.
Functions ¶
func InOrder ¶
func InOrder(ctx context.Context, out io.Writer, tags tag.ImageTags, platforms platform.Resolver, artifacts []*latest.Artifact, artifactBuilder ArtifactBuilder, concurrency int, store ArtifactStore) ([]graph.Artifact, error)
InOrder builds a list of artifacts in dependency order.
func MergeWithPreviousBuilds ¶
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.
func TagWithDigest ¶
func TagWithImageID ¶
Types ¶
type ArtifactBuilder ¶
type ArtifactBuilder func(ctx context.Context, out io.Writer, artifact *latest.Artifact, tag string, platforms platform.Matcher) (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 ArtifactStore ¶
type ArtifactStore interface { Record(a *latest.Artifact, tag string) GetImageTag(imageName string) (tag string, found bool) GetArtifacts(s []*latest.Artifact) ([]graph.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, platforms platform.Resolver, artifacts []*latest.Artifact) ([]graph.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, cache Cache, builder func(p latest.Pipeline) (PipelineBuilder, error)) (*BuilderMux, error)
NewBuilderMux returns an implementation of `build.BuilderMux`.
type Config ¶
type Config interface { GetPipelines() []latest.Pipeline DefaultRepo() *string Mode() config.RunMode MultiLevelRepo() *bool GlobalConfig() string BuildConcurrency() int }
Config represents an interface for getting all config pipelines.
type ErrCustomBuildNoDockerfile ¶
type ErrCustomBuildNoDockerfile struct{}
func (ErrCustomBuildNoDockerfile) Error ¶
func (ErrCustomBuildNoDockerfile) Error() string
type ErrSyncMapNotSupported ¶
type ErrSyncMapNotSupported struct{}
func (ErrSyncMapNotSupported) Error ¶
func (ErrSyncMapNotSupported) Error() string
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 // PushImages specifies if the built image needs to be explicitly pushed to an image registry. PushImages() bool // SupportedPlatforms returns the platforms supported for building the image by this build pipeline type. SupportedPlatforms() platform.Matcher }
PipelineBuilder is an interface for a specific Skaffold config pipeline build type. Current implementations are the `local`, `cluster` and `gcb`