v1

Documentation

Index

• Constants
• func WriteDockerCFG(ctx *BuildContext) error
• type BuildCache
• type BuildContext
  • func (c *BuildContext) Auth() ociutil.Auth
  • func (c *BuildContext) DockerCFG() string
  • func (c *BuildContext) Normalise()
• type BuildRecipe
• type BuildRepo
• type Dockerfile
• type DockerfileConfig
• type DockerfileContent
• type GoConfig
• type ImageConfig
• type Recipes
  • func ReadConfiguration(path string, ctx *BuildContext) (*Recipes, error)
  • func ReadConfigurations(ctx *BuildContext, paths ...string) (*Recipes, error)

Constants

const (
	EnvBuildExtraArgs = "BUILD_EXTRA_ARGS"
	EnvBuildArgPrefix = "BUILD_ARG_"
	// EnvBuildTags is a comma-separated list of
	// tags that should be added to the image. Tags
	// are only added on the trunk.
	EnvBuildTags = "BUILD_TAGS"
	// EnvBuildDockerfile dictates where Dockerfile-based recipes
	// should look for the Dockerfile
	EnvBuildDockerfile = "BUILD_DOCKERFILE"
	// EnvBuildGoImportPath dictates where Go-based recipes should
	// look for the main.go file
	EnvBuildGoImportPath = "BUILD_GO_IMPORTPATH"
	// EnvBuildImageParent dictates what the build tool should use as a base layer.
	// Some recipes (e.g. BuildKit) will ignore this.
	EnvBuildImageParent = "BUILD_IMAGE_PARENT"
	// EnvBuildSLSABuildType overrides the SLSA build type field.
	EnvBuildSLSABuildType = "BUILD_SLSA_BUILD_TYPE"

	// EnvBuildCacheEnabled dictates whether we should instruct build tools
	// to cache files. Disabling this may fix some problems at the cost of performance.
	EnvBuildCacheEnabled = "BUILD_CACHE_ENABLED"
	// EnvBuildCachePath describes the directory that
	// we should instruct build tools to store their temporary files.
	EnvBuildCachePath = "BUILD_CACHE_PATH"

	EnvDockerConfig = "DOCKER_CONFIG"
)

const (
	DefaultDockerfile = "Dockerfile"
	DefaultCacheName  = ".cache"
)

Functions

func WriteDockerCFG

func WriteDockerCFG(ctx *BuildContext) error

Types

type BuildCache

type BuildCache struct {
	Enabled bool
	Path    string
}

type BuildContext

type BuildContext struct {
	Builder    string
	BuildID    string
	Root       string
	Context    string
	Image      ImageConfig
	Tags       []string
	FQTags     []string
	Dockerfile DockerfileConfig
	Go         GoConfig
	Repo       BuildRepo
	Cache      BuildCache
	StartTime  string
	Provider   string
	ConfigPath string
	ExtraArgs  []string
}

func (*BuildContext) Auth

func (c *BuildContext) Auth() ociutil.Auth

func (*BuildContext) DockerCFG

func (c *BuildContext) DockerCFG() string

func (*BuildContext) Normalise

func (c *BuildContext) Normalise()

type BuildRecipe

type BuildRecipe struct {
	DockerCFG bool              `yaml:"dockercfg,omitempty"`
	CD        bool              `yaml:"cd,omitempty"`
	Env       map[string]string `yaml:"env,omitempty"`
	Command   string            `yaml:"command"`
	Args      []string          `yaml:"args,omitempty"`
}

type BuildRepo

type BuildRepo struct {
	URL       string
	CommitSha string
	Ref       string
	Trunk     bool
}

type Dockerfile

type Dockerfile struct {
	Content DockerfileContent `yaml:"content"`
}

type DockerfileConfig

type DockerfileConfig struct {
	File string
	Args []string
}

type DockerfileContent

type DockerfileContent struct {
	Inline string `yaml:"inline,omitempty"`
	File   string `yaml:"file,omitempty"`
}

type GoConfig

type GoConfig struct {
	ImportPath string
}

type ImageConfig

type ImageConfig struct {
	Parent   string
	Base     string
	Name     string
	Registry string
	Username string
	Password string
}

type Recipes

type Recipes struct {
	Build       map[string]BuildRecipe `yaml:"build"`
	Dockerfiles map[string]Dockerfile  `yaml:"dockerfiles"`
}

func ReadConfiguration

func ReadConfiguration(path string, ctx *BuildContext) (*Recipes, error)

func ReadConfigurations

func ReadConfigurations(ctx *BuildContext, paths ...string) (*Recipes, error)