compiler

Documentation

Index

• Constants
• type Compiler
  • func New(opts ...Option) *Compiler
  • func (c *Compiler) Compile(conf *yaml_types.Workflow) (*backend_types.Config, error)
• type ErrExtraHostFormat
  • func (err *ErrExtraHostFormat) Error() string
  • func (*ErrExtraHostFormat) Is(target error) bool
• type ErrStepDependencyCycle
  • func (err *ErrStepDependencyCycle) Error() string
  • func (*ErrStepDependencyCycle) Is(target error) bool
• type ErrStepMissingDependency
  • func (err *ErrStepMissingDependency) Error() string
  • func (*ErrStepMissingDependency) Is(target error) bool
• type Option
  • func WithDefaultClonePlugin(cloneImage string) Option
  • func WithEnviron(env map[string]string) Option
  • func WithEscalated(images ...string) Option
  • func WithLocal(local bool) Option
  • func WithMetadata(metadata metadata.Metadata) Option
  • func WithNetrc(username, password, machine string) Option
  • func WithNetrcOnlyTrusted(only bool) Option
  • func WithNetworks(networks ...string) Option
  • func WithOption(option Option, b bool) Option
  • func WithPrefix(prefix string) Option
  • func WithProxy(opt ProxyOptions) Option
  • func WithRegistry(registries ...Registry) Option
  • func WithSecret(secrets ...Secret) Option
  • func WithTrustedClonePlugins(images []string) Option
  • func WithTrustedSecurity(trusted bool) Option
  • func WithVolumes(volumes ...string) Option
  • func WithWorkspace(base, path string) Option
  • func WithWorkspaceFromURL(base, u string) Option
• type ProxyOptions
• type Registry
• type Secret
  • func (s *Secret) Available(event string, container *yaml_types.Container) error
  • func (s *Secret) Match(event string) bool

Constants

const (

	// DefaultWorkspaceBase is set if not altered by the user.
	DefaultWorkspaceBase = pluginWorkspaceBase
)

Types

type Compiler

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

Compiler compiles the yaml.

func New

func New(opts ...Option) *Compiler

New creates a new Compiler with options.

func (*Compiler) Compile

func (c *Compiler) Compile(conf *yaml_types.Workflow) (*backend_types.Config, error)

Compile compiles the YAML configuration to the pipeline intermediate representation configuration format.

type ErrExtraHostFormat

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

func (*ErrExtraHostFormat) Error

func (err *ErrExtraHostFormat) Error() string

func (*ErrExtraHostFormat) Is

func (*ErrExtraHostFormat) Is(target error) bool

type ErrStepDependencyCycle

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

func (*ErrStepDependencyCycle) Error

func (err *ErrStepDependencyCycle) Error() string

func (*ErrStepDependencyCycle) Is

func (*ErrStepDependencyCycle) Is(target error) bool

type ErrStepMissingDependency

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

func (*ErrStepMissingDependency) Error

func (err *ErrStepMissingDependency) Error() string

func (*ErrStepMissingDependency) Is

func (*ErrStepMissingDependency) Is(target error) bool

type Option

type Option func(*Compiler)

Option configures a compiler option.

func WithDefaultClonePlugin

func WithDefaultClonePlugin(cloneImage string) Option

func WithEnviron

func WithEnviron(env map[string]string) Option

WithEnviron configures the compiler with environment variables added by default to every container in the pipeline.

func WithEscalated

func WithEscalated(images ...string) Option

WithEscalated configures the compiler to automatically execute images as privileged containers if the match the given list.

func WithLocal

func WithLocal(local bool) Option

WithLocal configures the compiler with the local flag. The local flag indicates the pipeline execution is running in a local development environment with a mounted local working directory.

func WithMetadata

func WithMetadata(metadata metadata.Metadata) Option

WithMetadata configures the compiler with the repository, pipeline and system metadata. The metadata is used to remove steps from the compiled pipeline configuration that should be skipped. The metadata is also added to each container as environment variables.

func WithNetrc

func WithNetrc(username, password, machine string) Option

WithNetrc configures the compiler with netrc authentication credentials added by default to every container in the pipeline.

func WithNetrcOnlyTrusted

func WithNetrcOnlyTrusted(only bool) Option

WithNetrcOnlyTrusted configures the compiler with the netrcOnlyTrusted repo option.

func WithNetworks

func WithNetworks(networks ...string) Option

WithNetworks configures the compiler with additional networks to be connected to pipeline containers.

func WithOption

func WithOption(option Option, b bool) Option

WithOption configures the compiler with the given option if boolean b evaluates to true.

func WithPrefix

func WithPrefix(prefix string) Option

WithPrefix configures the compiler with the prefix. The prefix is used to prefix container, volume and network names to avoid collision at runtime.

func WithProxy

func WithProxy(opt ProxyOptions) Option

WithProxy configures the compiler with HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables added by default to every container in the pipeline.

func WithRegistry

func WithRegistry(registries ...Registry) Option

WithRegistry configures the compiler with registry credentials that should be used to download images.

func WithSecret

func WithSecret(secrets ...Secret) Option

WithSecret configures the compiler with external secrets to be injected into the container at runtime.

func WithTrustedClonePlugins

func WithTrustedClonePlugins(images []string) Option

func WithTrustedSecurity

func WithTrustedSecurity(trusted bool) Option

WithTrustedSecurity configures the compiler with the trusted repo option.

func WithVolumes

func WithVolumes(volumes ...string) Option

WithVolumes configures the compiler with default volumes that are mounted to each container in the pipeline.

func WithWorkspace

func WithWorkspace(base, path string) Option

WithWorkspace configures the compiler with the workspace base and path. The workspace base is a volume created at runtime and mounted into all containers in the pipeline. The base and path are joined to provide the working directory for all pipeline and plugin steps in the pipeline.

func WithWorkspaceFromURL

func WithWorkspaceFromURL(base, u string) Option

WithWorkspaceFromURL configures the compiler with the workspace base and path based on the repository url.

type ProxyOptions

type ProxyOptions struct {
	NoProxy    string
	HTTPProxy  string
	HTTPSProxy string
}

type Registry

type Registry struct {
	Hostname string
	Username string
	Password string
}

Registry represents registry credentials.

type Secret

type Secret struct {
	Name           string
	Value          string
	AllowedPlugins []string
	Events         []string
}

func (*Secret) Available

func (s *Secret) Available(event string, container *yaml_types.Container) error

func (*Secret) Match

func (s *Secret) Match(event string) bool

Match returns true if an image and event match the restricted list. Note that EventPullClosed are treated as EventPull.