config

Documentation

Index

• func ReadGodelConfigExcludesFromFile(cfgFilePath string) (matcher.NamesPathsCfg, error)
• func ToConfigProviderLocatorConfig(in ConfigProviderLocatorConfig) v0.ConfigProviderLocatorConfig
• func ToConfigProviderLocatorWithResolverConfig(in ConfigProviderLocatorWithResolverConfig) v0.ConfigProviderLocatorWithResolverConfig
• func ToDefaultTasksConfig(in DefaultTasksConfig) v0.DefaultTasksConfig
• func ToLocatorConfig(in LocatorConfig) v0.LocatorConfig
• func ToLocatorWithResolverConfig(in LocatorWithResolverConfig) v0.LocatorWithResolverConfig
• func ToLocatorWithResolverConfigs(in []LocatorWithResolverConfig) []v0.LocatorWithResolverConfig
• func ToPluginsConfig(in PluginsConfig) v0.PluginsConfig
• func ToSingleDefaultTaskConfig(in SingleDefaultTaskConfig) v0.SingleDefaultTaskConfig
• func ToSinglePluginConfig(in SinglePluginConfig) v0.SinglePluginConfig
• func ToSinglePluginConfigs(in []SinglePluginConfig) []v0.SinglePluginConfig
• func ToTasks(in map[string]SingleDefaultTaskConfig) map[string]v0.SingleDefaultTaskConfig
• func ToTasksConfig(in TasksConfig) v0.TasksConfig
• func UpgradeConfig(cfgBytes []byte) ([]byte, error)
• type ConfigProviderLocatorConfig
  • func (c *ConfigProviderLocatorConfig) ToLocatorConfig() (LocatorConfig, error)
• type ConfigProviderLocatorWithResolverConfig
  • func (c *ConfigProviderLocatorWithResolverConfig) ToParam() (artifactresolver.LocatorWithResolverParam, error)
• type DefaultTasksConfig
• type GodelConfig
  • func ReadGodelConfigFromFile(cfgFile string) (GodelConfig, error)
  • func ReadGodelConfigFromProjectDir(projectDir string) (GodelConfig, error)
• type LocatorConfig
  • func (c *LocatorConfig) ToParam() (artifactresolver.LocatorParam, error)
• type LocatorWithResolverConfig
  • func (c *LocatorWithResolverConfig) ToParam() (artifactresolver.LocatorWithResolverParam, error)
• type PluginsConfig
  • func (c *PluginsConfig) ToParam() (godellauncher.PluginsParam, error)
• type SingleDefaultTaskConfig
• type SinglePluginConfig
  • func (c *SinglePluginConfig) ToParam() (godellauncher.SinglePluginParam, error)
• type TasksConfig
  • func (c *TasksConfig) Combine(configs ...TasksConfig)
• type TasksConfigInfo
• type TasksConfigProvidersConfig
  • func (c *TasksConfigProvidersConfig) ToParam() (godellauncher.TasksConfigProvidersParam, error)

Functions

func ReadGodelConfigExcludesFromFile

func ReadGodelConfigExcludesFromFile(cfgFilePath string) (matcher.NamesPathsCfg, error)

ReadGodelConfigExcludesFromFile reads the excludes specified in the gödel godel configuration from the provided file and returns the loaded configuration. Returns an empty configuration if the file does not exist. Callers that only require the exclude configuration should prefer this function to using the ReadGodelConfigFrom* functions and accessing the exclude configuration there, as this function is more robust to configuration changes (for example, the ReadGodelConfigFrom* functions will return an error if the configuration has an unrecognized key, while this function only considers the "exclude" portion of configuration).

func ToConfigProviderLocatorConfig

func ToConfigProviderLocatorConfig(in ConfigProviderLocatorConfig) v0.ConfigProviderLocatorConfig

func ToConfigProviderLocatorWithResolverConfig

func ToConfigProviderLocatorWithResolverConfig(in ConfigProviderLocatorWithResolverConfig) v0.ConfigProviderLocatorWithResolverConfig

func ToDefaultTasksConfig

func ToDefaultTasksConfig(in DefaultTasksConfig) v0.DefaultTasksConfig

func ToLocatorConfig

func ToLocatorConfig(in LocatorConfig) v0.LocatorConfig

func ToLocatorWithResolverConfig

func ToLocatorWithResolverConfig(in LocatorWithResolverConfig) v0.LocatorWithResolverConfig

func ToLocatorWithResolverConfigs

func ToLocatorWithResolverConfigs(in []LocatorWithResolverConfig) []v0.LocatorWithResolverConfig

func ToPluginsConfig

func ToPluginsConfig(in PluginsConfig) v0.PluginsConfig

func ToSingleDefaultTaskConfig

func ToSingleDefaultTaskConfig(in SingleDefaultTaskConfig) v0.SingleDefaultTaskConfig

func ToSinglePluginConfig

func ToSinglePluginConfig(in SinglePluginConfig) v0.SinglePluginConfig

func ToSinglePluginConfigs

func ToSinglePluginConfigs(in []SinglePluginConfig) []v0.SinglePluginConfig

func ToTasks

func ToTasks(in map[string]SingleDefaultTaskConfig) map[string]v0.SingleDefaultTaskConfig

func ToTasksConfig

func ToTasksConfig(in TasksConfig) v0.TasksConfig

func UpgradeConfig

func UpgradeConfig(cfgBytes []byte) ([]byte, error)

Types

type ConfigProviderLocatorConfig

type ConfigProviderLocatorConfig v0.ConfigProviderLocatorConfig

ConfigProviderLocatorConfig is the configuration for a locator for a configuration provider. It differs from a LocatorConfig in that only a single checksum can be specified.

func (*ConfigProviderLocatorConfig) ToLocatorConfig

func (c *ConfigProviderLocatorConfig) ToLocatorConfig() (LocatorConfig, error)

ToLocatorConfig translates the ConfigProviderLocatorConfig into a LocatorConfig where the checksum (if any exists) is keyed as the current OS/Arch.

type ConfigProviderLocatorWithResolverConfig

type ConfigProviderLocatorWithResolverConfig v0.ConfigProviderLocatorWithResolverConfig

ConfigProviderLocatorWithResolverConfig is the configuration for a locator with resolver for a configuration provider. It differs from a LocatorWithResolverConfig in that the locator is a ConfigProviderLocatorConfig rather than a LocatorConfig.

func (*ConfigProviderLocatorWithResolverConfig) ToParam

func (c *ConfigProviderLocatorWithResolverConfig) ToParam() (artifactresolver.LocatorWithResolverParam, error)

ToParam converts the configuration into a LocatorWithResolverParam. Any checksums that exist are put in a map where the key is the current OS/Arch.

type DefaultTasksConfig

type DefaultTasksConfig v0.DefaultTasksConfig

type GodelConfig

type GodelConfig v0.GodelConfig

func ReadGodelConfigFromFile

func ReadGodelConfigFromFile(cfgFile string) (GodelConfig, error)

ReadGodelConfigFromFile reads the gödel configuration from the provided file and returns the loaded configuration. Returns an empty configuration if the file does not exist.

func ReadGodelConfigFromProjectDir

func ReadGodelConfigFromProjectDir(projectDir string) (GodelConfig, error)

ReadGodelConfigFromProjectDir reads the gödel configuration from the "godel.yml" file in the configuration directory for the gödel project with the specified project directory and returns it. Returns an empty configuration if the configuration file does not exist.

type LocatorConfig

type LocatorConfig v0.LocatorConfig

func (*LocatorConfig) ToParam

func (c *LocatorConfig) ToParam() (artifactresolver.LocatorParam, error)

type LocatorWithResolverConfig

type LocatorWithResolverConfig v0.LocatorWithResolverConfig

func (*LocatorWithResolverConfig) ToParam

func (c *LocatorWithResolverConfig) ToParam() (artifactresolver.LocatorWithResolverParam, error)

type PluginsConfig

type PluginsConfig v0.PluginsConfig

func (*PluginsConfig) ToParam

func (c *PluginsConfig) ToParam() (godellauncher.PluginsParam, error)

type SingleDefaultTaskConfig

type SingleDefaultTaskConfig v0.SingleDefaultTaskConfig

type SinglePluginConfig

type SinglePluginConfig v0.SinglePluginConfig

func (*SinglePluginConfig) ToParam

func (c *SinglePluginConfig) ToParam() (godellauncher.SinglePluginParam, error)

type TasksConfig

type TasksConfig v0.TasksConfig

func (*TasksConfig) Combine

func (c *TasksConfig) Combine(configs ...TasksConfig)

Combine combines the provided TasksConfig configurations with the base configuration. In cases where values are overwritten, the last (most recent) values in the inputs will take precedence.

type TasksConfigInfo

type TasksConfigInfo struct {
	// BuiltinPluginsConfig is the configuration for built-in plugins that is built as part of gödel.
	BuiltinPluginsConfig PluginsConfig
	// TasksConfig is the fully resolved user-provided tasks configuration.
	TasksConfig TasksConfig
	// DefaultTasksPluginsConfig is the plugin configuration used to load the default tasks. It is a result of combining
	// the BuiltinPluginsConfig with the DefaultTasks config of TasksConfig.
	DefaultTasksPluginsConfig PluginsConfig
}

type TasksConfigProvidersConfig

type TasksConfigProvidersConfig v0.TasksConfigProvidersConfig

func (*TasksConfigProvidersConfig) ToParam

func (c *TasksConfigProvidersConfig) ToParam() (godellauncher.TasksConfigProvidersParam, error)