v1alpha

Documentation

Index

• type BuildContext
• type BuildRequest
• type BuildRequestOutput
• type BuildRequestProvider
• type BuildRequestProviderOption
• type BuiltFile
• type DockerBuildRequest

Types

type BuildContext

type BuildContext interface {
	Architecture() common.Architecture
	OperatingSystem() common.OperatingSystem
}

BuildContext is an interface that provides a context for builds

type BuildRequest

type BuildRequest interface {
}

BuildRequest is a generic interface for build requests

type BuildRequestOutput

type BuildRequestOutput interface {
	AddFile(file BuiltFile)
	Files() []BuiltFile
}

BuildRequestOutput is an interface for the results of a build request

type BuildRequestProvider

type BuildRequestProvider interface {
	Initialize(options ...BuildRequestProviderOption) error
	Execute(buildContext BuildContext, buildRequest BuildRequest) (BuildRequestOutput, error)
}

BuildRequestProvider is a provider that processes build requests

type BuildRequestProviderOption

type BuildRequestProviderOption interface {
	Apply(BuildRequestProvider) error
}

BuildRequestProviderOption is a option for a BuildRequestProvider

type BuiltFile

type BuiltFile interface {
	Name() string
	User() string
	Group() string
	Body() []byte
	Size() int
	Mode() os.FileMode
	Type() pkg.FileType
}

BuiltFile represents a built file

type DockerBuildRequest

type DockerBuildRequest struct {
	Dockerfile     string               `yaml:"dockerfile"`             // Dockerfile is the contents of the Dockerfile
	DockerIgnore   string               `yaml:"dockerignore,omitempty"` // DockerIgnore is the contents of the .dockerignore file
	Tags           []string             `yaml:"tags,omitempty"`         // Tags are tags to apply to the built docker image
	BuildArgs      map[string]string    `yaml:"buildargs,omitempty"`    // BuildArgs are arguments to pass while building the docker image
	ExtraFiles     common.EmbeddedFiles `yaml:"files, omitempty"`       // ExtraFiles are files to include in the docker build process
	BuildDirectory string               `yaml:"buildDirectory"`         // BuildDirectory is the output directory where built files are generated
}

DockerBuildRequest represents a request a build request using docker