Documentation
¶
Overview ¶
Package config provides configuration for taskrunner.
Config is the exported, usable configuration object, built from ReadConfig.
Internally, the package represents the json file as a separate struct type, configFile. This distinction helps make features like extending configurations easier to support and test.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// WorkingDir is the resolved working directory from the "path" attribute.
WorkingDir string
// CaonfigPath is the path to the file from where this config was loaded.
ConfigPath string
// DesiredTasks is the set of tasks to run specified by this configuration.
DesiredTasks []string
}
Config defines user parameters for taskrunner. It is usually loaded via ReadUserConfig or ReadConfig.
func ReadConfig ¶
ReadConfig reads the configuration at configPath and returns a Config.
func ReadDefaultConfig ¶
ReadDefaultConfig reads the default configuration from workspace.taskrunner.json. If present, user.taskrunner.json will be used instead.
Source Files
Click to show internal directories.
Click to hide internal directories.