actions

Documentation

Index

• Constants
• type Container
• type Defaults
  • func (d Defaults) Run(run Run)
• type Job
• type Matrix
  • func (m Matrix) Include(values map[string]string)
• type Run
• type Service
• type Shell
• type Step
• type Strategy
• type VirtualEnvironment
• type With
  • func (w With) Args(args string)
  • func (w With) Entrypoint(entrypoint string)
• type Workflow

Constants

const (
	WithArgsKey       = "args"
	WithEntrypointKey = "entrypoint"
)

const DefaultsRunKey = "run"

const MatrixIncludeKey = "include"

Types

type Container

type Container struct {
	Image   string            `yaml:",omitempty"`
	Env     map[string]string `yaml:",omitempty"`
	Ports   []string          `yaml:",omitempty"`
	Volumes []string          `yaml:",omitempty"`
	Options string            `yaml:",omitempty"`
}

type Defaults

type Defaults map[string]interface{}

func (Defaults) Run

func (d Defaults) Run(run Run)

type Job

type Job struct {
	Name            string               `yaml:",omitempty"`
	If              string               `yaml:",omitempty"`
	Needs           []string             `yaml:",omitempty"`
	RunsOn          []VirtualEnvironment `yaml:"runs-on,omitempty"`
	Outputs         map[string]string    `yaml:",omitempty"`
	Env             map[string]string    `yaml:",omitempty"`
	Environment     map[string]string    `yaml:",omitempty"`
	Defaults        Defaults             `yaml:",omitempty"`
	Steps           []Step               `yaml:",omitempty"`
	TimeoutMinutes  int                  `yaml:",omitempty"`
	Strategy        Strategy             `yaml:",omitempty"`
	ContinueOnError bool                 `yaml:"continue-on-error,omitempty"`
	Container       Container            `yaml:",omitempty"`
	Services        map[string]Service   `yaml:",omitempty"`
}

The ordering of the struct fields is intentional for better YAML readability after the marshalling Read more: https://github.com/paketo-buildpacks/pipeline-builder/pull/399

type Matrix

type Matrix map[string][]interface{}

func (Matrix) Include

func (m Matrix) Include(values map[string]string)

type Run

type Run struct {
	Shell            Shell  `yaml:",omitempty"`
	WorkingDirectory string `yaml:"working-directory,omitempty"`
}

type Service

type Service struct {
	Image   string            `yaml:",omitempty"`
	Env     map[string]string `yaml:",omitempty"`
	Ports   []string          `yaml:",omitempty"`
	Volumes []string          `yaml:",omitempty"`
	Options string            `yaml:",omitempty"`
}

type Shell

type Shell string

const (
	Bash       Shell = "bash"
	Pwsh       Shell = "pwsh"
	Python     Shell = "python"
	Sh         Shell = "sh"
	Cmd        Shell = "cmd"
	Powershell Shell = "powershell"
)

type Step

type Step struct {
	Name             string            `yaml:",omitempty"`
	If               string            `yaml:",omitempty"`
	Id               string            `yaml:",omitempty"`
	Uses             string            `yaml:",omitempty"`
	Run              string            `yaml:",omitempty"`
	WorkingDirectory string            `yaml:"working-directory,omitempty"`
	Shell            Shell             `yaml:",omitempty"`
	With             With              `yaml:",omitempty"`
	Env              map[string]string `yaml:",omitempty"`
	ContinueOnError  bool              `yaml:"continue-on-error,omitempty"`
	TimeoutMinutes   int               `yaml:",omitempty"`
}

type Strategy

type Strategy struct {
	Matrix      Matrix `yaml:",omitempty"`
	FailFast    bool   `yaml:"fail-fast,omitempty"`
	MaxParallel int    `yaml:"max-parallel:omitempty"`
}

type VirtualEnvironment

type VirtualEnvironment string

const (
	WindowsLatest VirtualEnvironment = "windows-latest"
	Windows2019   VirtualEnvironment = "windows-2019"
	Ubuntu2004    VirtualEnvironment = "ubuntu-20.04"
	UbuntuLatest  VirtualEnvironment = "ubuntu-latest"
	Ubuntu1804    VirtualEnvironment = "ubuntu-18.04"
	Ubuntu1604    VirtualEnvironment = "ubuntu-16.04"
	MacOSLatest   VirtualEnvironment = "macos-latest"
	MacOS1015     VirtualEnvironment = "macos-10.15"
	SelfHosted    VirtualEnvironment = "self-hosted"
)

type With

type With map[string]interface{}

func (With) Args

func (w With) Args(args string)

func (With) Entrypoint

func (w With) Entrypoint(entrypoint string)

type Workflow

type Workflow struct {
	Name     string                     `yaml:",omitempty"`
	On       map[event.Type]event.Event `yaml:",omitempty"`
	Env      map[string]string          `yaml:",omitempty"`
	Defaults Defaults                   `yaml:",omitempty"`
	Jobs     map[string]Job             `yaml:",omitempty"`
}