build

Documentation

Index

• type Artifact
• type Builder
  • func NewBuilder(manifest *Manifest, conf *configuration.Config) *Builder
  • func (b *Builder) BuildStep(step *Step) error
  • func (b *Builder) StartBuild() error
• type Cleanup
• type Manifest
  • func LoadBuildFromFile(config *configuration.Config) (*Manifest, error)
  • func (m *Manifest) FindStepByLabel(label string) (*Step, error)
  • func (m *Manifest) FindStepByName(name string) (*Step, error)
• type Secret
• type Step

Types

type Artifact

type Artifact struct {
	Step   Step
	Source string
	Dest   string // this is only the folder. Filename comes from the source
}

Artifact holds a parsed source for a build artifact

type Builder

type Builder struct {
	Build    *Manifest
	UniqueID string // unique id for this build sequence. This is used for multi-tenanted environments
	Conf     *configuration.Config
	// contains filtered or unexported fields
}

Builder is a simple Dockerfile builder

func NewBuilder

func NewBuilder(manifest *Manifest, conf *configuration.Config) *Builder

NewBuilder creates a new builder in a new session

func (*Builder) BuildStep

func (b *Builder) BuildStep(step *Step) error

BuildStep builds a single step

func (*Builder) StartBuild

func (b *Builder) StartBuild() error

StartBuild runs the build process end to end

type Cleanup

type Cleanup struct {
	Commands []string
}

Cleanup holds everything that's needed for a cleanup

type Manifest

type Manifest struct {
	Steps           []Step
	IsPrivileged    bool
	SecretProviders map[string]secrets.SecretProvider
	// contains filtered or unexported fields
}

Manifest Holds the whole build process

func LoadBuildFromFile

func LoadBuildFromFile(config *configuration.Config) (*Manifest, error)

LoadBuildFromFile loads Build from a yaml file

func (*Manifest) FindStepByLabel

func (m *Manifest) FindStepByLabel(label string) (*Step, error)

func (*Manifest) FindStepByName

func (m *Manifest) FindStepByName(name string) (*Step, error)

FindStepByName finds a step by name. Returns nil if not found

type Secret

type Secret struct {
	Name  string
	Type  string
	Value string
}

holds a single secret

type Step

type Step struct {
	Name       string
	Label      string
	Dockerfile string
	Artifacts  []Artifact
	Manifest   Manifest
	Cleanup    *Cleanup
	DependsOn  []*Step
	Command    string
	Secrets    []Secret
}

Step Holds a single step in the build process Public structs. They are used to store the build for the builders