Documentation
¶
Index ¶
- type AddSSHKeys
- type AttachWorkspace
- type Checkout
- type Command
- type Config
- type Custom
- type Docker
- type DockerAuth
- type DockerAuthAWS
- type Executor
- type Filter
- type Filters
- type Job
- type JobExecutor
- type Logical
- type Machine
- type Macos
- type Matches
- type Matrix
- type Orb
- type Parameter
- type PersistToWorkspace
- type RestoreCache
- type Run
- type SaveCache
- type Schedule
- type SetupRemoteDocker
- type Step
- type StoreArtifacts
- type StoreTestResults
- type Stringorslice
- type Trigger
- type Unless
- type When
- type Workflow
- type WorkflowJob
- type Workflows
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddSSHKeys ¶
type AttachWorkspace ¶
type Config ¶
type Config struct {
Commands map[string]*Command `yaml:"commands,omitempty"`
Executors map[string]*Executor `yaml:"executors,omitempty"`
Jobs map[string]*Job `yaml:"jobs,omitempty"`
Orbs map[string]*Orb `yaml:"orbs,omitempty"`
Parameters map[string]*Parameter `yaml:"parameters,omitempty"`
Setup bool `yaml:"setup,omitempty"`
Workflows *Workflows `yaml:"workflows,omitempty"`
Version string `yaml:"version,omitempty"`
}
func ParseBytes ¶
ParseBytes parses the configuration from bytes b.
func ParseString ¶
ParseString parses the configuration from string s.
type Docker ¶
type Docker struct {
Auth *DockerAuth `yaml:"auth,omitempty"`
AuthAWS *DockerAuthAWS `yaml:"aws_auth,omitempty"`
Command Stringorslice `yaml:"command,omitempty"`
Entrypoint Stringorslice `yaml:"entrypoint,omitempty"`
Environment map[string]string `yaml:"environment,omitempty"`
Image string `yaml:"image,omitempty"`
Name string `yaml:"name,omitempty"`
User string `yaml:"user,omitempty"`
}
type DockerAuth ¶
type DockerAuthAWS ¶
type Executor ¶
type Executor struct {
Docker []*Docker `yaml:"docker,omitempty"`
ResourceClass string `yaml:"resource_class,omitempty"`
Machine *Machine `yaml:"machine,omitempty"`
Macos *Macos `yaml:"macos,omitempty"`
Windows interface{} `yaml:"widows,omitempty"`
Shell string `yaml:"shell,omitempty"`
WorkingDir string `yaml:"working_directory,omitempty"`
Environment map[string]string `yaml:"environment,omitempty"`
}
type Filter ¶
type Filter struct {
Only Stringorslice `yaml:"only,omitempty"`
Ignore Stringorslice `yaml:"ignore,omitempty"`
}
type Job ¶
type Job struct {
Branches *Filter `yaml:"branches,omitempty"`
Docker []*Docker `yaml:"docker,omitempty"`
Environment map[string]string `yaml:"environment,omitempty"`
Executor *JobExecutor `yaml:"executor,omitempty"`
IPRanges bool `yaml:"circleci_ip_ranges,omitempty"`
Machine *Machine `yaml:"machine,omitempty"`
Macos *Macos `yaml:"macos,omitempty"`
Parallelism int `yaml:"parallelism,omitempty"`
Parameters map[string]*Parameter `yaml:"parameters,omitempty"`
ResourceClass string `yaml:"resource_class,omitempty"`
Shell string `yaml:"shell,omitempty"`
Steps []*Step `yaml:"steps,omitempty"`
WorkingDir string `yaml:"working_directory,omitempty"`
}
type JobExecutor ¶
func (*JobExecutor) MarshalYAML ¶
func (v *JobExecutor) MarshalYAML() (interface{}, error)
MarshalYAML implements the marshal interface.
func (*JobExecutor) UnmarshalYAML ¶
func (v *JobExecutor) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the unmarshal interface.
type Logical ¶
type Logical struct {
Literal interface{}
And []*Logical
Equal []interface{}
Matches *Matches
Not *Logical
Or []*Logical
}
func (*Logical) MarshalYAML ¶
MarshalYAML implements the marshal interface.
func (*Logical) UnmarshalYAML ¶
UnmarshalYAML implements the unmarshal interface.
type Machine ¶
type Machine struct {
Default bool `yaml:"default,omitempty"`
Image string `yaml:"image,omitempty"`
Shell string `yaml:"shell,omitempty"`
DockerLayerCaching bool `yaml:"docker_layer_caching,omitempty"`
}
func (*Machine) MarshalYAML ¶
MarshalYAML implements the marshal interface.
func (*Machine) UnmarshalYAML ¶
UnmarshalYAML implements the unmarshal interface.
type Orb ¶
func (*Orb) MarshalYAML ¶
MarshalYAML implements the marshal interface.
func (*Orb) UnmarshalYAML ¶
UnmarshalYAML implements the unmarshal interface.
type PersistToWorkspace ¶
type PersistToWorkspace struct {
Name string `yaml:"name,omitempty"`
Paths Stringorslice `yaml:"paths,omitempty"`
Root string `yaml:"root,omitempty"`
}
type RestoreCache ¶
type RestoreCache struct {
Key string `yaml:"key,omitempty"`
Name string `yaml:"name,omitempty"`
Keys Stringorslice `yaml:"keys,omitempty"`
}
type Run ¶
type Run struct {
Background bool
Command string
Environment map[string]string
Name string
NoOutputTimeout string
Shell string
When string
WorkingDirectory string
}
func (*Run) MarshalYAML ¶
MarshalYAML implements the marshal interface.
func (*Run) UnmarshalYAML ¶
UnmarshalYAML implements the unmarshal interface.
type SaveCache ¶
type SaveCache struct {
Key string `yaml:"key,omitempty"`
Name string `yaml:"name,omitempty"`
Paths Stringorslice `yaml:"paths,omitempty"`
When string `yaml:"when,omitempty"`
}
type SetupRemoteDocker ¶
type Step ¶
type Step struct {
AddSSHKeys *AddSSHKeys
AttachWorkspace *AttachWorkspace
Checkout *Checkout
PersistToWorkspace *PersistToWorkspace
RestoreCache *RestoreCache
Run *Run
SaveCache *SaveCache
SetupRemoteDocker *SetupRemoteDocker
StoreArtifacts *StoreArtifacts
StoreTestResults *StoreTestResults
Unless *Unless
When *When
Custom *Custom
}
func (*Step) MarshalYAML ¶
MarshalYAML implements the marshal interface.
func (*Step) UnmarshalYAML ¶
UnmarshalYAML implements the unmarshal interface.
type StoreArtifacts ¶
type StoreTestResults ¶
type Stringorslice ¶
type Stringorslice []string
Stringorslice represents a string or an array of strings.
func (*Stringorslice) UnmarshalYAML ¶
func (s *Stringorslice) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the unmarshal interface.
type Workflow ¶
type Workflow struct {
Jobs []*WorkflowJob `yaml:"jobs,omitempty"`
Triggers []*Trigger `yaml:"triggers,omitempty"`
Unless *Logical `yaml:"when,omitempty"`
When *Logical `yaml:"unless,omitempty"`
}
type WorkflowJob ¶
type WorkflowJob struct {
Name string
Context []string
Filters *Filters
Matrix *Matrix
Type string
Requires []string
Params map[string]interface{} // custom params
}
func (*WorkflowJob) MarshalYAML ¶
func (v *WorkflowJob) MarshalYAML() (interface{}, error)
MarshalYAML implements the marshal interface.
func (*WorkflowJob) UnmarshalYAML ¶
func (v *WorkflowJob) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the unmarshal interface.