config

Documentation

Index

• func ValidateConfig(cfg *Config) error
• type BootstrapConfig
• type CacheConfig
• type CleanupConfig
• type Config
  • func NewConfig(file string) *Config
  • func (c *Config) LoadConfig() error
  • func (c *Config) UnmarshalYAML(node *yaml.Node) error
• type ConfigValidator
  • func NewConfigValidator(cfg *Config) *ConfigValidator
  • func (v *ConfigValidator) Validate() error
• type ExtendsList
  • func (e *ExtendsList) UnmarshalYAML(node *yaml.Node) error
• type JobBootstrapConfig
• type JobCleanupConfig
• type JobConfig
  • func ExpandMatrix(job JobConfig) ([]JobConfig, error)
  • func (j *JobConfig) IsParallel() bool
• type MatrixEntry
  • func (m *MatrixEntry) UnmarshalYAML(node *yaml.Node) error
• type NetworkConfig
• type RemoteProvider

Functions

func ValidateConfig

func ValidateConfig(cfg *Config) error

Types

type BootstrapConfig

type BootstrapConfig struct {
	Run     []string `yaml:"run"`
	Timeout int      `yaml:"timeout,omitempty"`
}

type CacheConfig

type CacheConfig struct {
	Key   string   `yaml:"key"`
	Paths []string `yaml:"paths"`
}

type CleanupConfig

type CleanupConfig struct {
	Run     []string `yaml:"run"`
	Timeout int      `yaml:"timeout,omitempty"`
}

type Config

type Config struct {
	FileName        string
	Stages          []string          `yaml:"stages"`
	Jobs            []JobConfig       `yaml:"-"`
	GlobalVariables map[string]string `yaml:"variables,omitempty"`
	RemoteProvider  *RemoteProvider   `yaml:"remote_provider,omitempty"`
	CLIVariables    map[string]string `yaml:"-"`
	Bootstrap       *BootstrapConfig  `yaml:"bootstrap,omitempty"`
	Cleanup         *CleanupConfig    `yaml:"cleanup,omitempty"`
	Include         []string          `yaml:"include,omitempty"`
}

func NewConfig

func NewConfig(file string) *Config

func (*Config) LoadConfig

func (c *Config) LoadConfig() error

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(node *yaml.Node) error

type ConfigValidator

type ConfigValidator struct {
	// contains filtered or unexported fields
}

func NewConfigValidator

func NewConfigValidator(cfg *Config) *ConfigValidator

func (*ConfigValidator) Validate

func (v *ConfigValidator) Validate() error

type ExtendsList

type ExtendsList []string

func (*ExtendsList) UnmarshalYAML

func (e *ExtendsList) UnmarshalYAML(node *yaml.Node) error

type JobBootstrapConfig

type JobBootstrapConfig struct {
	Run     []string `yaml:"run"`
	Timeout int      `yaml:"timeout,omitempty"`
}

type JobCleanupConfig

type JobCleanupConfig struct {
	Run     []string `yaml:"run"`
	Timeout int      `yaml:"timeout,omitempty"`
}

type JobConfig

type JobConfig struct {
	Name         string              `yaml:"-"`
	Image        string              `yaml:"image"`
	Script       []string            `yaml:"script"`
	Stage        string              `yaml:"stage"`
	Workdir      string              `yaml:"workdir,omitempty"`
	Variables    map[string]string   `yaml:"variables,omitempty"`
	Cache        *CacheConfig        `yaml:"cache,omitempty"`
	Network      *NetworkConfig      `yaml:"network,omitempty"`
	JobBootstrap *JobBootstrapConfig `yaml:"job_bootstrap,omitempty"`
	JobCleanup   *JobCleanupConfig   `yaml:"job_cleanup,omitempty"`
	Parallel     *bool               `yaml:"parallel,omitempty"`
	Matrix       []MatrixEntry       `yaml:"matrix,omitempty"`
	MatrixGroup  string              `yaml:"-"`
	Extends      ExtendsList         `yaml:"extends,omitempty"`
}

func ExpandMatrix

func ExpandMatrix(job JobConfig) ([]JobConfig, error)

ExpandMatrix returns the variants generated by a job's matrix definition. If the job has no matrix, it returns the job unchanged in a single-element slice. Each variant has a unique Name (suffixed with key.value pairs), a fresh Variables map containing the parent's variables plus the matrix values, and a MatrixGroup field set to the original job name.

func (*JobConfig) IsParallel

func (j *JobConfig) IsParallel() bool

IsParallel returns true only when the job has explicitly opted into the per-job parallel mode (`parallel: true`). A nil pointer (no `parallel:` key in YAML) or an explicit `parallel: false` both report false.

type MatrixEntry

type MatrixEntry map[string][]string

func (*MatrixEntry) UnmarshalYAML

func (m *MatrixEntry) UnmarshalYAML(node *yaml.Node) error

type NetworkConfig

type NetworkConfig struct {
	HostAccess bool `yaml:"host_access,omitempty"`
	HostMode   bool `yaml:"host_mode,omitempty"`
}

type RemoteProvider

type RemoteProvider struct {
	Url       string `yaml:"url"`
	ProjectId int    `yaml:"project_id"`
	Token     string `yaml:"access_token"`
}