config

Documentation

Overview

Package config defines the basic config format.

Index

• Variables
• type Config
  • func LoadFile(file string, loader Loader, disableDeprecated bool) (*Config, error)
• type Loader
• type TaskMap

Variables

var (
	// TasksMap is a lookup table for tasks
	TasksMap = map[string]tasks.Task{}
)

Types

type Config

type Config struct {
	Tasks         map[string]tasks.Task
	Plans         map[string]plans.Plan
	MetaPlans     map[string]plans.MetaPlan
	SSHIdentities []string
	Environment   []string
}

Config represents a full convey configuration.

func LoadFile

func LoadFile(file string, loader Loader, disableDeprecated bool) (*Config, error)

LoadFile will determine the file name and override file name and then call the loaders methods to load them.

type Loader

type Loader interface {
	Load(path, base string, data []byte, disableDeprecated bool) (*Config, error)
	LoadOverride(path, base string, data []byte, config *Config, disableDeprecated bool)
	Filenames() []string
	OverrideSuffix() string
	DefaultPlan() string
	ResolvePlanName(plan string, cfg *Config, st *state.State) string
}

Loader defines all the functions that a config loader needs to implement.

type TaskMap

type TaskMap map[string]tasks.Task

TaskMap is a type alias for a map of task names to tasks.