v0

Documentation

Index

• func UpgradeConfig(cfgBytes []byte) ([]byte, error)
• type ConfigProviderLocatorConfig
• type ConfigProviderLocatorWithResolverConfig
• type DefaultTasksConfig
• type GodelConfig
• type LocatorConfig
• type LocatorWithResolverConfig
• type PluginsConfig
• type SingleDefaultTaskConfig
• type SinglePluginConfig
• type TasksConfig
• type TasksConfigProvidersConfig

Functions

func UpgradeConfig

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

Types

type ConfigProviderLocatorConfig

type ConfigProviderLocatorConfig struct {
	ID       string `yaml:"id,omitempty"`
	Checksum string `yaml:"checksum,omitempty"`
}

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.

type ConfigProviderLocatorWithResolverConfig

type ConfigProviderLocatorWithResolverConfig struct {
	Locator  ConfigProviderLocatorConfig `yaml:"locator,omitempty"`
	Resolver string                      `yaml:"resolver,omitempty"`
}

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.

type DefaultTasksConfig

type DefaultTasksConfig struct {
	DefaultResolvers []string                           `yaml:"resolvers,omitempty"`
	Tasks            map[string]SingleDefaultTaskConfig `yaml:"tasks,omitempty"`
}

type GodelConfig

type GodelConfig struct {
	// Version of the configuration
	versionedconfig.ConfigWithVersion `yaml:",inline,omitempty"`

	// TasksConfigProviders specifies the providers used to load provided task configuration.
	TasksConfigProviders TasksConfigProvidersConfig `yaml:"tasks-config-providers,omitempty"`

	// Environment specifies the environment variables that are set by gödel when it is run.
	Environment map[string]string `yaml:"environment,omitempty"`

	// TasksConfig contains the configuration for the tasks (default and plugin).
	TasksConfig `yaml:",inline,omitempty"`

	// Exclude specifies the files and directories that should be excluded from gödel operations.
	Exclude matcher.NamesPathsCfg `yaml:"exclude,omitempty"`
}

type LocatorConfig

type LocatorConfig struct {
	ID        string            `yaml:"id,omitempty"`
	Checksums map[string]string `yaml:"checksums,omitempty"`
}

type LocatorWithResolverConfig

type LocatorWithResolverConfig struct {
	Locator  LocatorConfig `yaml:"locator,omitempty"`
	Resolver string        `yaml:"resolver,omitempty"`
}

type PluginsConfig

type PluginsConfig struct {
	DefaultResolvers []string             `yaml:"resolvers,omitempty"`
	Plugins          []SinglePluginConfig `yaml:"plugins,omitempty"`
}

type SingleDefaultTaskConfig

type SingleDefaultTaskConfig struct {
	// LocatorWithResolverConfig contains the configuration for the locator and resolver. Any value provided here
	// overrides the default value.
	LocatorWithResolverConfig `yaml:",inline,omitempty"`
	// ExcludeAllDefaultAssets specifies whether or not all of the default assets should be excluded. If this value is
	// true, then DefaultAssetsToExclude is ignored.
	ExcludeAllDefaultAssets bool `yaml:"exclude-all-default-assets,omitempty"`
	// DefaultAssetsToExclude specifies the assets that should be excluded if they are provided by the default
	// configuration. Only used if ExcludeAllDefaultAssets is false.
	DefaultAssetsToExclude []string `yaml:"exclude-default-assets,omitempty"`
	// Assets specifies the custom assets that should be added to the default task.
	Assets []LocatorWithResolverConfig `yaml:"assets,omitempty"`
}

type SinglePluginConfig

type SinglePluginConfig struct {
	// LocatorWithResolverConfig stores the locator and the resolver for the plugin.
	LocatorWithResolverConfig `yaml:",inline,omitempty"`
	// Override is used to override a plugin found in the ConfigProvider that has the same locator as this plugin.
	Override bool `yaml:"override,omitempty"`
	// Assets stores the locators and resolvers for the assets for this plugin.
	Assets []LocatorWithResolverConfig `yaml:"assets,omitempty"`
}

type TasksConfig

type TasksConfig struct {
	// DefaultTasks specifies the configuration for the default tasks for gödel.
	DefaultTasks DefaultTasksConfig `yaml:"default-tasks,omitempty"`
	// Plugins specifies the configuration for the plugins configured for gödel.
	Plugins PluginsConfig `yaml:"plugins,omitempty"`
}

type TasksConfigProvidersConfig

type TasksConfigProvidersConfig struct {
	DefaultResolvers []string                                  `yaml:"resolvers,omitempty"`
	ConfigProviders  []ConfigProviderLocatorWithResolverConfig `yaml:"providers,omitempty"`
}