exec

Documentation

Index

• func Exec(payload Payload, opt Options, outw, errw io.Writer) error
• type Error
  • func (e *Error) Error() string
• type Options
• type Payload

Functions

func Exec

func Exec(payload Payload, opt Options, outw, errw io.Writer) error

Exec executes a build with the given payload and options. If the build fails, an *Error is returned.

Types

type Error

type Error struct {
	ExitCode int // exit code
}

Error reports an error during execution of a build.

func (*Error) Error

func (e *Error) Error() string

type Options

type Options struct {
	Cache  bool   // execute cache steps
	Clone  bool   // execute clone steps
	Build  bool   // execute build steps
	Deploy bool   // execute deploy steps
	Notify bool   // execute notify steps
	Debug  bool   // execute in debug mode
	Force  bool   // force pull plugin images
	Mount  string // mounts the volume on the host machine
}

Options defines execution options.

type Payload

type Payload struct {
	Yaml      string            `json:"config"`
	YamlEnc   string            `json:"secret"`
	Repo      *plugin.Repo      `json:"repo"`
	Build     *plugin.Build     `json:"build"`
	BuildLast *plugin.Build     `json:"build_last"`
	Job       *plugin.Job       `json:"job"`
	Netrc     *plugin.Netrc     `json:"netrc"`
	Keys      *plugin.Keypair   `json:"keys"`
	System    *plugin.System    `json:"system"`
	Workspace *plugin.Workspace `json:"workspace"`
}

Payload defines the raw plugin payload that stores the build metadata and configuration.