builtin

Documentation

Index

• Constants
• func BuildOp(node parse.Node) error
• type Visitor
  • func NewAliasOp(prefix string) Visitor
  • func NewArgsOp() Visitor
  • func NewCacheOp(plugin, mount string, enable bool) Visitor
  • func NewCloneOp(plugin string, enable bool) Visitor
  • func NewEnvOp(envs map[string]string) Visitor
  • func NewEscalateOp(plugins []string) Visitor
  • func NewFilterOp(status, branch, event, env string, matrix map[string]string) Visitor
  • func NewNormalizeOp(namespace string) Visitor
  • func NewPodOp(name string) Visitor
  • func NewPullOp(pull bool) Visitor
  • func NewSecretOp(event string, secrets []*model.Secret) Visitor
  • func NewShellOp(platform string) Visitor
  • func NewValidateOp(trusted bool, plugins []string) Visitor
  • func NewWorkspaceOp(base, path string) Visitor

Constants

const (
	Freebsd_amd64 = "freebsd_amd64"
	Linux_adm64   = "linux_amd64"
	Windows_amd64 = "windows_amd64"
)

Functions

func BuildOp

func BuildOp(node parse.Node) error

BuildOp is a transform operation that converts the build section of the Yaml to a step in the pipeline responsible for building the Docker image.

Types

type Visitor

type Visitor interface {
	VisitRoot(*parse.RootNode) error
	VisitVolume(*parse.VolumeNode) error
	VisitNetwork(*parse.NetworkNode) error
	VisitBuild(*parse.BuildNode) error
	VisitContainer(*parse.ContainerNode) error
}

Visitor interface for walking the Yaml file.

func NewAliasOp

func NewAliasOp(prefix string) Visitor

func NewArgsOp

func NewArgsOp() Visitor

NewArgsOp returns a transformer that provides the plugin node with the custom arguments from the Yaml file.

func NewCacheOp

func NewCacheOp(plugin, mount string, enable bool) Visitor

NewCacheOp returns a transformer that configures the default cache plugin.

func NewCloneOp

func NewCloneOp(plugin string, enable bool) Visitor

NewCloneOp returns a transformer that configures the default clone plugin.

func NewEnvOp

func NewEnvOp(envs map[string]string) Visitor

NewEnvOp returns a transformer that sets default environment variables for each container, service and plugin.

func NewEscalateOp

func NewEscalateOp(plugins []string) Visitor

NewEscalateOp returns a transformer that configures plugins to automatically execute in privileged mode. This is intended for plugins running dind.

func NewFilterOp

func NewFilterOp(status, branch, event, env string, matrix map[string]string) Visitor

NewFilterOp returns a transformer that filters (ie removes) steps from the process based on conditional logic in the yaml.

func NewNormalizeOp

func NewNormalizeOp(namespace string) Visitor

NewNormalizeOp returns a transformer that normalizes the container image names and plugin names to their fully qualified values.

func NewPodOp

func NewPodOp(name string) Visitor

NewPodOp returns a transformer that configures an ambassador container providing shared networking and container volumes.

func NewPullOp

func NewPullOp(pull bool) Visitor

NewPullOp returns a transformer that configures plugins to automatically pull the latest images at runtime.

func NewSecretOp

func NewSecretOp(event string, secrets []*model.Secret) Visitor

NewSecretOp returns a transformer that configures plugin secrets.

func NewShellOp

func NewShellOp(platform string) Visitor

NewShellOp returns a transformer that converts the shell node to a runnable container.

func NewValidateOp

func NewValidateOp(trusted bool, plugins []string) Visitor

NewValidateOp returns a linter that checks container configuration.

func NewWorkspaceOp

func NewWorkspaceOp(base, path string) Visitor

NewWorkspaceOp returns a transformer that provides a default workspace paths, including the base path (mounted as a volume) and absolute path where the code is cloned.