api

Documentation

Index

• Constants
• type ConfigExecOutput
• type DriverInfo

Constants

const (
	// The name of the variable used to pass the value of Build failure exit code
	// that should be returned from Custom executor driver
	BuildFailureExitCodeVariable = "BUILD_FAILURE_EXIT_CODE"

	// The name of the variable used to pass the value of System failure exit code
	// that should be returned from Custom executor driver
	SystemFailureExitCodeVariable = "SYSTEM_FAILURE_EXIT_CODE"
)

Types

type ConfigExecOutput

type ConfigExecOutput struct {
	Driver *DriverInfo `json:"driver,omitempty"`

	Hostname  *string `json:"hostname,omitempty"`
	BuildsDir *string `json:"builds_dir,omitempty"`
	CacheDir  *string `json:"cache_dir,omitempty"`

	BuildsDirIsShared *bool `json:"builds_dir_is_shared,omitempty"`
}

ConfigExecOutput defines the output structure of the config_exec call.

This should be used to pass the configuration values from Custom Executor driver to the Runner.

type DriverInfo

type DriverInfo struct {
	Name    *string `json:"name,omitempty"`
	Version *string `json:"version,omitempty"`
}

DriverInfo wraps the information about Custom Executor driver details like the name or version