Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Args ¶
type Args struct {
// Config provides the parsed pipeline config. This config is
// the compiler source and is converted to the intermediate
// representation by the Compile method.
Config *harness.Config
// Build provides the compiler with stage information that
// is converted to environment variable format and passed to
// each pipeline step. It is also used to clone the commit.
Build *drone.Build
// Stage provides the compiler with stage information that
// is converted to environment variable format and passed to
// each pipeline step.
Stage *drone.Stage
// Repo provides the compiler with repo information. This
// repo information is converted to environment variable
// format and passed to each pipeline step. It is also used
// to clone the repository.
Repo *drone.Repo
// System provides the compiler with system information that
// is converted to environment variable format and passed to
// each pipeline step.
System *drone.System
// Netrc provides netrc parameters that can be used by the
// default clone step to authenticate to the remote
// repository.
Netrc *drone.Netrc
// Secret returns a named secret value that can be injected
// into the pipeline step.
Secret secret.Provider
}
Args provides compiler arguments.
type Compiler ¶
Compiler compiles the Yaml configuration file to an intermediate representation optimized for simple execution.
type CompilerImpl ¶
type CompilerImpl struct {
// Environ provides a set of environment variables that
// should be added to each pipeline step by default.
Environ provider.Provider
// Labels provides a set of labels that should be added
// to each container by default.
Labels map[string]string
// Privileged provides a list of docker images that
// are always privileged.
Privileged []string
// Networks provides a set of networks that should be
// attached to each pipeline container.
Networks []string
// NetworkOpts provides a set of network options that
// are used when creating the docker network.
NetworkOpts map[string]string
// NetrcCloneOnly instructs the compiler to only inject
// the netrc file into the clone step.
NetrcCloneOnly bool
// Volumes provides a set of volumes that should be
// mounted to each pipeline container.
Volumes map[string]string
// ExtraHosts provides a set of hostname mappings that
// should be setup for each pipeline container.
ExtraHosts []string
// Clone overrides the default plugin image used
// when cloning a repository.
Clone string
// Resources provides global resource constraints
// applies to pipeline containers.
Resources Resources
// Tmate provides global configuration options for tmate
// live debugging.
Tmate Tmate
// Secret returns a named secret value that can be injected
// into the pipeline step.
Secret secret.Provider
// Registry returns a list of registry credentials that can be
// used to pull private container images.
Registry registry.Provider
// Mount is an optional field that overrides the default
// workspace volume and mounts to the host path
Mount string
}
CompilerImpl compiles the Yaml configuration file to an intermediate representation optimized for simple execution.
Click to show internal directories.
Click to hide internal directories.