Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

engine

package

Go to main page

Versions in this module

v1

v1.1.1

Jul 26, 2026

v1.1.0

Jul 14, 2026

Changes in this version

+ const DroneEnvironmentFileVariable

+ const EnvironmentFilePath

+ const EnvironmentFilePathWindows

+ const EnvironmentFileVariable

type Engine

+ ReadFile func(context.Context, *Spec, *Step, string) ([]byte, error)

type Step

+ EnvOverrides map[string]bool

v1.0.1

Jul 1, 2026

Changes in this version

+ type DockerAuth struct

+ Address string

+ Password string

+ Username string

+ func LookupAuth(spec *Spec, domain string) (*DockerAuth, bool)

+ type DockerConfig struct

+ Auths []*DockerAuth

+ Volumes []*Volume

+ type DockerStep struct

+ Args []string

+ Command []string

+ DNS []string

+ DNSSearch []string

+ ExtraHosts []string

+ Image string

+ Network string

+ Networks []string

+ Ports []*Port

+ Privileged bool

+ PullPolicy PullPolicy

+ User string

+ type Engine interface

+ Create func(context.Context, *Spec, *Step) error

+ Destroy func(context.Context, *Spec) error

+ Setup func(context.Context, *Spec) error

+ Start func(context.Context, *Spec, *Step) error

+ Tail func(context.Context, *Spec, *Step) (io.ReadCloser, error)

+ Wait func(context.Context, *Spec, *Step) (*State, error)

+ type File struct

+ Data []byte

+ Metadata Metadata

+ func LookupFile(spec *Spec, name string) (*File, bool)

+ type FileMount struct

+ Mode int64

+ Name string

+ Path string

+ type FusionConfig struct

+ Image string

+ type Metadata struct

+ Labels map[string]string

+ Name string

+ Namespace string

+ UID string

+ type Platform struct

+ Arch string

+ OS string

+ Variant string

+ Version string

+ type Port struct

+ Host int

+ Port int

+ Protocol string

+ type PullPolicy int

+ const PullAlways

+ const PullDefault

+ const PullIfNotExists

+ const PullNever

+ func (p *PullPolicy) MarshalJSON() ([]byte, error)

+ func (p *PullPolicy) UnmarshalJSON(b []byte) error

+ func (p PullPolicy) String() string

+ type QemuConfig struct

+ Image string

+ type ResourceObject struct

+ CPU int64

+ Memory int64

+ type Resources struct

+ Limits *ResourceObject

+ Requests *ResourceObject

+ type RunPolicy int

+ const RunAlways

+ const RunNever

+ const RunOnFailure

+ const RunOnSuccess

+ func (r *RunPolicy) MarshalJSON() ([]byte, error)

+ func (r *RunPolicy) UnmarshalJSON(b []byte) error

+ func (r RunPolicy) String() string

+ type Secret struct

+ Data string

+ Metadata Metadata

+ func LookupSecret(spec *Spec, secret *SecretVar) (*Secret, bool)

+ type SecretVar struct

+ Env string

+ Name string

+ type Spec struct

+ Docker *DockerConfig

+ Files []*File

+ Fusion *FusionConfig

+ Metadata Metadata

+ Platform Platform

+ Qemu *QemuConfig

+ Secrets []*Secret

+ Steps []*Step

+ func Parse(r io.Reader) (*Spec, error)

+ func ParseFile(path string) (*Spec, error)

+ func ParseString(s string) (*Spec, error)

+ type State struct

+ ExitCode int

+ Exited bool

+ OOMKilled bool

+ type Step struct

+ DependsOn []string

+ Detach bool

+ Devices []*VolumeDevice

+ Docker *DockerStep

+ Envs map[string]string

+ Files []*FileMount

+ IgnoreErr bool

+ IgnoreStderr bool

+ IgnoreStdout bool

+ Metadata Metadata

+ Resources *Resources

+ RunPolicy RunPolicy

+ Secrets []*SecretVar

+ Volumes []*VolumeMount

+ WorkingDir string

+ type Volume struct

+ EmptyDir *VolumeEmptyDir

+ HostPath *VolumeHostPath

+ Metadata Metadata

+ func LookupVolume(spec *Spec, name string) (*Volume, bool)

+ type VolumeDevice struct

+ DevicePath string

+ Name string

+ type VolumeEmptyDir struct

+ Medium string

+ SizeLimit int64

+ type VolumeHostPath struct

+ Path string

+ type VolumeMount struct

+ Name string

+ Path string

v1.0.0

Jul 1, 2026