Documentation ¶
Overview ¶
Package convey provides the config loader for convey configurations.
Index ¶
- Constants
- Variables
- type Loader
- func (l *Loader) DefaultPlan() string
- func (l *Loader) Filenames() []string
- func (l *Loader) Load(path, base string, data []byte, disableDeprecated bool) (*cConfig.Config, error)
- func (l *Loader) LoadOverride(path, base string, data []byte, config *cConfig.Config, disableDeprecated bool)
- func (l *Loader) OverrideSuffix() string
- func (l *Loader) ResolvePlanName(plan string, cfg *cConfig.Config, st *state.State) string
Constants ¶
View Source
const (
// MaxExtendsDepth is the maximum depth that configs can extend each other.
MaxExtendsDepth = 50
)
Variables ¶
View Source
var ( // ErrNoTasks is used to represent a config that doesn't have any tasks // defined. ErrNoTasks = errors.New("no tasks specified") // ErrNoPlans is used to represent a config that doesn't have any plans // defined. ErrNoPlans = errors.New("no plans specified") // ErrMaxExtendsDepth is returned when a cycle has been found in configs // that extend each other. ErrMaxExtendsDepth = errors.New("exceeded allowed depth for extended configs") )
Functions ¶
This section is empty.
Types ¶
type Loader ¶
type Loader struct {
// contains filtered or unexported fields
}
Loader is a loader.Loader for loading convey.yml files.
func (*Loader) DefaultPlan ¶
DefaultPlan returns the default plan name.
func (*Loader) Filenames ¶
Filenames returns a string slice of filenames that are valid for this loader.
func (*Loader) Load ¶
func (l *Loader) Load(path, base string, data []byte, disableDeprecated bool) (*cConfig.Config, error)
Load loads the given filename and returns it as a config.Config.
func (*Loader) LoadOverride ¶
func (l *Loader) LoadOverride(path, base string, data []byte, config *cConfig.Config, disableDeprecated bool)
LoadOverride loads the given override file into the given config.Config.
func (*Loader) OverrideSuffix ¶
OverrideSuffix returns the suffix for override filenames.
Click to show internal directories.
Click to hide internal directories.