Documentation
¶
Index ¶
Constants ¶
View Source
const (
DefinitionFileName = ".codectl.yaml"
)
Variables ¶
This section is empty.
Functions ¶
func LoadValuesFromFile ¶ added in v0.2.0
Types ¶
type Overrides ¶ added in v0.5.0
type Overrides struct {
//Paths contains the file/folder names and the override values
Paths map[string]string `yaml:"paths"`
}
Overrides defines replacement text for names of items in the templates
type Parameter ¶
type Parameter struct {
// Name of the parameter
Name string `yaml:"name"`
// Prompt is the text to be displayed when prompting
// the user for the parameter
Prompt string `yaml:"prompt"`
// Value of the parameter
Value string `yaml:"value"`
// Required indicates if the parameter is required
Required bool `yaml:"required"`
}
type Properties ¶
type Properties struct {
// Name of the template
Name string `yaml:"name"`
// Version of the template
Version string `yaml:"version"`
// Description of the template
Description string `yaml:"description"`
// Parameters is the list of parameters expected by the template
Parameters []Parameter `yaml:"parameters"`
// Dependencies is a list of the paths of the dependent templates that will be
// called with this one
Dependencies []string `yaml:"dependencies"`
// Overrides contains a list of paths that will have their names
// changed to the values in the override before template processing occurs
Overrides Overrides `yaml:"overrides"`
}
Click to show internal directories.
Click to hide internal directories.