drone

Documentation

Index

• func ConvertEventConditions(cond constraint.List, w *types.Workflow) ([]string, []error)
• func New() transform.Transformer
• func TriggerToGlobalWhen(trigger *Trigger) (constraint.When, []error)
• type Clone
• type Conditions
  • func (c *Conditions) IsEmpty() bool
  • func (c *Conditions) Transform() constraint.List
  • func (c *Conditions) UnmarshalYAML(unmarshal func(interface{}) error) error
• type DronePipeline
  • func (d DronePipeline) Convert(pipeline *Pipeline) (*types.Workflow, []error)
  • func (d DronePipeline) ConvertConditions(when *When, w *types.Workflow) (constraint.When, []error)
  • func (d DronePipeline) ConvertImage(image string) string
  • func (d DronePipeline) ConvertVolumes(volumes []*Volume, refs []VolumeRef) ([]*types.Volume, []error)
  • func (d DronePipeline) PostProcess(yaml []byte) ([]byte, error)
  • func (d DronePipeline) Transform(sources []*transform.Source) ([]transform.Destination, error)
• type Pipeline
• type Platform
• type Service
• type Setting
• type Settings
  • func (s Settings) MarshalYAML() (interface{}, error)
  • func (s Settings) Transform() map[string]any
  • func (s *Settings) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Step
• type Trigger
• type UnsupportedEventError
  • func (e UnsupportedEventError) Error() string
  • func (e UnsupportedEventError) Is(target error) bool
• type Volume
• type VolumeHost
• type VolumeRef
• type VolumeTemp
• type When
• type Workspace

Functions

func ConvertEventConditions

func ConvertEventConditions(cond constraint.List, w *types.Workflow) ([]string, []error)

ConvertEventConditions converts a Drone *Conditions for the event field into a Woodpecker constraint.List, mapping event names along the way.

func New

func New() transform.Transformer

func TriggerToGlobalWhen

func TriggerToGlobalWhen(trigger *Trigger) (constraint.When, []error)

Types

type Clone

type Clone struct {
	Disable bool `yaml:"disable"`
	Depth   *int `yaml:"depth"`
}

type Conditions

type Conditions struct {
	Conditions core.Strings `yaml:"-"`
	Include    core.Strings `yaml:"include,omitempty"`
	Exclude    core.Strings `yaml:"exclude,omitempty"`
}

func (*Conditions) IsEmpty

func (c *Conditions) IsEmpty() bool

func (*Conditions) Transform

func (c *Conditions) Transform() constraint.List

func (*Conditions) UnmarshalYAML

func (c *Conditions) UnmarshalYAML(unmarshal func(interface{}) error) error

type DronePipeline

type DronePipeline struct{}

func (DronePipeline) Convert

func (d DronePipeline) Convert(pipeline *Pipeline) (*types.Workflow, []error)

func (DronePipeline) ConvertConditions

func (d DronePipeline) ConvertConditions(when *When, w *types.Workflow) (constraint.When, []error)

func (DronePipeline) ConvertImage

func (d DronePipeline) ConvertImage(image string) string

func (DronePipeline) ConvertVolumes

func (d DronePipeline) ConvertVolumes(volumes []*Volume, refs []VolumeRef) ([]*types.Volume, []error)

func (DronePipeline) PostProcess

func (d DronePipeline) PostProcess(yaml []byte) ([]byte, error)

func (DronePipeline) Transform

func (d DronePipeline) Transform(sources []*transform.Source) ([]transform.Destination, error)

type Pipeline

type Pipeline struct {
	Kind      string            `yaml:"kind"`
	Type      string            `yaml:"type"`
	Name      string            `yaml:"name"`
	Platform  *Platform         `yaml:"platform"`
	Workspace *Workspace        `yaml:"workspace"`
	Node      map[string]string `yaml:"node"`
	Clone     *Clone            `yaml:"clone"`
	Services  []*Service        `yaml:"services"`
	Steps     []*Step           `yaml:"steps"`
	Trigger   *Trigger          `yaml:"trigger"`
	DependsOn []string          `yaml:"depends_on"`
	Volumes   []*Volume         `yaml:"volumes"`
}

type Platform

type Platform struct {
	OS      string `yaml:"os"`
	Arch    string `yaml:"arch"`
	Version string `yaml:"version"`
}

type Service

type Service struct {
	Name        string             `yaml:"name"`
	Image       string             `yaml:"image"`
	Pull        string             `yaml:"pull"`
	Environment core.MapOrEnvArray `yaml:"environment"`
	Commands    []string           `yaml:"commands"`
	Entrypoint  []string           `yaml:"entrypoint"`
	Privileged  bool               `yaml:"privileged"`
	Volumes     []VolumeRef        `yaml:"volumes"`
	WorkingDir  string             `yaml:"working_dir"`
}

type Setting

type Setting struct {
	Name  string
	Value interface{}
}

type Settings

type Settings []Setting

func (Settings) MarshalYAML

func (s Settings) MarshalYAML() (interface{}, error)

func (Settings) Transform

func (s Settings) Transform() map[string]any

func (*Settings) UnmarshalYAML

func (s *Settings) UnmarshalYAML(unmarshal func(interface{}) error) error

type Step

type Step struct {
	Name        string             `yaml:"name"`
	Image       string             `yaml:"image"`
	Pull        string             `yaml:"pull"`
	Environment core.MapOrEnvArray `yaml:"environment"`
	Settings    Settings           `yaml:"settings"`
	Commands    []string           `yaml:"commands"`
	DependsOn   []string           `yaml:"depends_on"`
	Detach      bool               `yaml:"detach"`
	Privileged  bool               `yaml:"privileged"`
	Failure     string             `yaml:"failure"`
	Volumes     []VolumeRef        `yaml:"volumes"`
	When        *When              `yaml:"when"`
	User        string             `yaml:"user"`
}

type Trigger

type Trigger struct {
	Branch       *Conditions  `yaml:"branch"`
	Event        *Conditions  `yaml:"event"`
	Ref          *Conditions  `yaml:"ref"`
	Repositories *Conditions  `yaml:"repo"`
	Status       core.Strings `yaml:"status"`
	Target       *Conditions  `yaml:"target"`
	Cron         *Conditions  `yaml:"cron"`
	Action       *Conditions  `yaml:"action"`
	Paths        *Conditions  `yaml:"paths"`
}

https://docs.drone.io/pipeline/docker/syntax/trigger

type UnsupportedEventError

type UnsupportedEventError struct {
	Event string
}

func (UnsupportedEventError) Error

func (e UnsupportedEventError) Error() string

func (UnsupportedEventError) Is

func (e UnsupportedEventError) Is(target error) bool

type Volume

type Volume struct {
	Name string      `yaml:"name"`
	Host *VolumeHost `yaml:"host"`
	Temp *VolumeTemp `yaml:"temp"`
}

type VolumeHost

type VolumeHost struct {
	Path string `yaml:"path"`
}

type VolumeRef

type VolumeRef struct {
	Name string `yaml:"name"`
	Path string `yaml:"path"`
}

type VolumeTemp

type VolumeTemp struct {
	Medium string `yaml:"medium"`
}

type When

type When struct {
	Branch       *Conditions  `yaml:"branch"`
	Event        *Conditions  `yaml:"event"`
	Ref          *Conditions  `yaml:"ref"`
	Repositories *Conditions  `yaml:"repo"`
	Instance     *Conditions  `yaml:"instance"`
	Status       core.Strings `yaml:"status"`
	Target       *Conditions  `yaml:"target"`
	Cron         *Conditions  `yaml:"cron"`
}

https://docs.drone.io/pipeline/docker/syntax/conditions

type Workspace

type Workspace struct {
	Base string `yaml:"base"`
	Path string `yaml:"path"`
}