config

Documentation

Index

• Variables
• func ValidateDependencyImage(image string) error
• type BundleConfig
  • func (b *BundleConfig) SetDefaults()
• type BundleEnvConfig
• type Config
  • func NewConfig() *Config
  • func NewConfigWithRepoFile(path string) *Config
  • func (c *Config) AllTargets() []*models.Target
  • func (c *Config) BuildsPath() string
  • func (c *Config) Bundles() map[string]*models.Bundle
  • func (c *Config) CacheDir() string
  • func (c *Config) DagPath() string
  • func (c *Config) EnvironmentDependencies() map[string]models.EnvironmentDependency
  • func (c *Config) QueryTargets(query func(*models.Target) bool) []*models.Target
  • func (c *Config) Repo() *RepoConfig
  • func (c *Config) RepoRoot() string
  • func (c *Config) ResolveTarget(ref string) (*models.Target, error)
• type DotenvConfig
• type EnvironmentDependency
  • func (d *EnvironmentDependency) SetDefaults()
• type InitStep
• type LoggerConfig
• type LoggerDateTimeConfig
• type ProjectConfig
• type RepoConfig
  • func (r *RepoConfig) SetDefaults()
• type RepoEnvConfig
• type TargetConfig
  • func (t *TargetConfig) GetCmd() string
  • func (t *TargetConfig) SetDefaults()
• type TargetOptions

Variables

var (
	ErrMissingBundleName    = errors.New("missing bundle name")
	ErrMissingTargetName    = errors.New("missing target name")
	ErrMissingTargetCommand = errors.New("missing target command")
	ErrInvalidTargetRef     = errors.New("invalid target ref")
	ErrInvalidDependency    = errors.New("invalid dependency")
	ErrMissingProjectName   = errors.New("missing project name")
)

Functions

func ValidateDependencyImage

func ValidateDependencyImage(image string) error

Types

type BundleConfig

type BundleConfig struct {
	Name    string          `koanf:"name"`
	Env     BundleEnvConfig `koanf:"env"`
	Targets []TargetConfig  `koanf:"targets"`
}

func (*BundleConfig) SetDefaults

func (b *BundleConfig) SetDefaults()

type BundleEnvConfig

type BundleEnvConfig struct {
	Variables map[string]string `koanf:"variables"`
	Deps      []string          `koanf:"deps"`
}

type Config

type Config struct {
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig() *Config

func NewConfigWithRepoFile

func NewConfigWithRepoFile(path string) *Config

func (*Config) AllTargets

func (c *Config) AllTargets() []*models.Target

func (*Config) BuildsPath

func (c *Config) BuildsPath() string

func (*Config) Bundles

func (c *Config) Bundles() map[string]*models.Bundle

func (*Config) CacheDir

func (c *Config) CacheDir() string

func (*Config) DagPath

func (c *Config) DagPath() string

func (*Config) EnvironmentDependencies

func (c *Config) EnvironmentDependencies() map[string]models.EnvironmentDependency

func (*Config) QueryTargets

func (c *Config) QueryTargets(query func(*models.Target) bool) []*models.Target

func (*Config) Repo

func (c *Config) Repo() *RepoConfig

func (*Config) RepoRoot

func (c *Config) RepoRoot() string

func (*Config) ResolveTarget

func (c *Config) ResolveTarget(ref string) (*models.Target, error)

type DotenvConfig

type DotenvConfig struct {
	Enabled *bool    `koanf:"enabled"`
	Files   []string `koanf:"files"`
}

type EnvironmentDependency

type EnvironmentDependency struct {
	Name         string            `koanf:"name"`
	Image        string            `koanf:"image"`
	Env          map[string]string `koanf:"env"`
	Ports        []string          `koanf:"ports"`
	Volumes      []string          `koanf:"volumes"`
	ReadinessCmd string            `koanf:"readiness-cmd"`
}

func (*EnvironmentDependency) SetDefaults

func (d *EnvironmentDependency) SetDefaults()

type InitStep

type InitStep struct {
	Label      string `koanf:"label"`
	CheckCmd   string `koanf:"check_cmd"`
	InstallCmd string `koanf:"install_cmd"`
}

type LoggerConfig

type LoggerConfig struct {
	DateTime LoggerDateTimeConfig `koanf:"datetime"`
}

type LoggerDateTimeConfig

type LoggerDateTimeConfig struct {
	Format string `koanf:"format"`
}

type ProjectConfig

type ProjectConfig struct {
	Name string `koanf:"name"`
}

type RepoConfig

type RepoConfig struct {
	Project ProjectConfig `koanf:"project"`
	Shell   string        `koanf:"shell"`
	Env     RepoEnvConfig `koanf:"env"`
	Init    []InitStep    `koanf:"init"`
	Ignore  []string      `koanf:"ignore"`
	Logger  LoggerConfig  `koanf:"logger"`
}

func (*RepoConfig) SetDefaults

func (r *RepoConfig) SetDefaults()

type RepoEnvConfig

type RepoEnvConfig struct {
	Vars map[string]string       `koanf:"vars"`
	Deps []EnvironmentDependency `koanf:"deps"`
}

type TargetConfig

type TargetConfig struct {
	Name   string            `koanf:"name"`
	In     []string          `koanf:"in"`
	Out    []string          `koanf:"out"`
	Deps   []string          `koanf:"deps"`
	Env    map[string]string `koanf:"env"`
	Cmd    interface{}       `koanf:"cmd"`
	Config TargetOptions     `koanf:"config"`
}

func (*TargetConfig) GetCmd

func (t *TargetConfig) GetCmd() string

func (*TargetConfig) SetDefaults

func (t *TargetConfig) SetDefaults()

type TargetOptions

type TargetOptions struct {
	WorkingDir string       `koanf:"working_dir"`
	Dotenv     DotenvConfig `koanf:"dotenv"`
	Reload     *bool        `koanf:"reload"`
	Ignore     []string     `koanf:"ignore"`
	Index      *int         `koanf:"index"`
}