builder

Documentation

Index

• func NewExecutor(name string, useCache, tty bool) (executor.Executor, error)
• type Builder
  • func NewBuilder(tty bool, omitFuncs []string) (*Builder, error)
  • func (b *Builder) AddVerb(name string, vd *verbDefinition)
  • func (b *Builder) Close() error
  • func (b *Builder) ImageID() string
  • func (b *Builder) Mrb() *mruby.Mrb
  • func (b *Builder) Run(script string) (*mruby.MrbValue, error)
  • func (b *Builder) RunCode(val *mruby.MrbValue, stackKeep int) (*mruby.MrbValue, int, error)
  • func (b *Builder) SetCache(useCache bool)
  • func (b *Builder) Tag(name string) error

Functions

func NewExecutor

func NewExecutor(name string, useCache, tty bool) (executor.Executor, error)

NewExecutor returns a valid executor for the given name, or error.

Types

type Builder

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

Builder implements the builder core.

func NewBuilder

func NewBuilder(tty bool, omitFuncs []string) (*Builder, error)

NewBuilder creates a new builder. Returns error on docker or mruby issues.

func (*Builder) AddVerb

func (b *Builder) AddVerb(name string, vd *verbDefinition)

AddVerb adds a function to the mruby dispatch as well as adding hooks around the call to ensure containers are committed and intermediate layers are cleared.

func (*Builder) Close

func (b *Builder) Close() error

Close tears down all functions of the builder, preparing it for exit.

func (*Builder) ImageID

func (b *Builder) ImageID() string

ImageID returns the latest known Image identifier that we committed. At the end of the run this will be the golden docker image.

func (*Builder) Mrb

func (b *Builder) Mrb() *mruby.Mrb

Mrb returns the mrb (mruby) instance the builder is using.

func (*Builder) Run

func (b *Builder) Run(script string) (*mruby.MrbValue, error)

Run the script.

func (*Builder) RunCode

func (b *Builder) RunCode(val *mruby.MrbValue, stackKeep int) (*mruby.MrbValue, int, error)

RunCode runs the ruby value (a proc) and returns the result.

func (*Builder) SetCache

func (b *Builder) SetCache(useCache bool)

SetCache sets the caching strategy for builds. Turn on to use caching, off to not. The default is set to whether or not the environment variable (NO_CACHE) is non-empty.

func (*Builder) Tag

func (b *Builder) Tag(name string) error

Tag tags the last image yielded by the builder with the provided name.