config

Documentation

Index

• type Config
  • func Default() *Config
  • func Load(configData any) (*Config, error)

Types

type Config

type Config struct {
	// TypeHintPlugins holds a list of plugins that will be used when building a type hint (e.g. JSONSchema) file for
	// workflows.
	TypeHintPlugins []string `json:"plugins" yaml:"plugins"`
	// LocalDeployer holds the configuration for executing plugins locally. This deployer is used to obtain the schema
	// from the plugins before executing them in a remote environment.
	LocalDeployer any `json:"deployer" yaml:"deployer"`
	// Log configures logging for workflow runs.
	Log log.Config `json:"log" yaml:"log"`
}

Config is the main configuration structure that configures the engine for execution. It is not identical to the workflow being executed.

func Default

func Default() *Config

Default returns the default configuration.

func Load

func Load(configData any) (*Config, error)

Load loads a configuration data set into the config struct.