yey

Documentation

Index

• Variables
• func ContainerName(path string, context Context) string
• func ContainerPathPrefix(path string) string
• func ImageName(dockerfile []byte) string
• func Log(format string, a ...interface{})
• type Context
  • func (c Context) Clone() Context
  • func (c Context) GetAllImagesAndPlatforms(platform string) []ImageAndPlatform
  • func (c Context) GetCombos() [][]string
  • func (c Context) GetContext(names []string) (Context, error)
  • func (c Context) Merge(source Context, withVariations bool) Context
  • func (c Context) String() string
• type ContextFile
• type Contexts
  • func LoadContexts() (Contexts, error)
  • func (c Contexts) Merge(source Contexts) Contexts
• type DockerBuild
• type ImageAndPlatform
• type Variation
  • func (l Variation) Clone() Variation
  • func (l Variation) Merge(source Variation) Variation
• type Variations
  • func (l Variations) Clone() Variations
  • func (l Variations) GetByName(name string) (Variation, bool)
  • func (l Variations) Merge(source Variations) Variations
  • func (variations *Variations) UnmarshalYAML(n *yaml.Node) error

Variables

var (
	IsDryRun bool
)

var (
	IsVerbose bool
)

Functions

func ContainerName

func ContainerName(path string, context Context) string

ContainerName returns the container name to use for given yey rc path and context

func ContainerPathPrefix

func ContainerPathPrefix(path string) string

func ImageName

func ImageName(dockerfile []byte) string

func Log

func Log(format string, a ...interface{})

Types

type Context

type Context struct {
	Name       string     `yaml:",omitempty"`
	Variations Variations `yaml:"variations"`
	Remove     *bool
	Image      string
	Build      DockerBuild
	Env        map[string]string
	Mounts     map[string]string
	EntryPoint string `yaml:"entrypoint,omitempty"`
	Cmd        []string
	Network    string
	Platform   string   `yaml:"platform,omitempty"`
	DockerArgs []string `yaml:"dockerArgs,omitempty"`
}

Context represents execution configuration for some docker container

func (Context) Clone

func (c Context) Clone() Context

Clone returns a deep-copy of this context

func (Context) GetAllImagesAndPlatforms

func (c Context) GetAllImagesAndPlatforms(platform string) []ImageAndPlatform

GetAllImagesAndPlatforms returns the list of image names referenced in context recursively

func (Context) GetCombos

func (c Context) GetCombos() [][]string

GetCombos returns the list of all possible context name combinations user can choose from

func (Context) GetContext

func (c Context) GetContext(names []string) (Context, error)

GetContext returns context resulting from merging contexts with given names from all variations

func (Context) Merge

func (c Context) Merge(source Context, withVariations bool) Context

Merge creates a deep-copy of this context and copies values from given source context on top of it

func (Context) String

func (c Context) String() string

String returns a user-friendly yaml representation of this context

type ContextFile

type ContextFile struct {
	Version int
	Parent  string
	Path    string `yaml:"-"`
	Context `yaml:",inline"`
}

ContextFile represents yey's current config persisted to disk

type Contexts

type Contexts struct {
	Path string
	Context
}

Contexts represents a combinaison of base and named contexts

func LoadContexts

func LoadContexts() (Contexts, error)

LoadContexts reads the context file and returns the contexts. It starts by reading from current working directory and resolves all parent context files.

func (Contexts) Merge

func (c Contexts) Merge(source Contexts) Contexts

Merge creates a deep-copy of this object and copies values from given source object on top of it

type DockerBuild

type DockerBuild struct {
	Dockerfile string
	Args       map[string]string
	Context    string
}

type ImageAndPlatform

type ImageAndPlatform struct {
	Image    string
	Platform string
}

type Variation

type Variation struct {
	Name     string
	Contexts map[string]Context
}

func (Variation) Clone

func (l Variation) Clone() Variation

Clone returns a deep-copy of this variation

func (Variation) Merge

func (l Variation) Merge(source Variation) Variation

Merge creates a deep-copy of this variation and copies values from given source variation on top of it

type Variations

type Variations []Variation

func (Variations) Clone

func (l Variations) Clone() Variations

Clone returns a deep-copy of this variation

func (Variations) GetByName

func (l Variations) GetByName(name string) (Variation, bool)

GetByName returns variation with given name and whether it was found

func (Variations) Merge

func (l Variations) Merge(source Variations) Variations

Merge creates a deep-copy of this variation and copies values from given source variation on top of it

func (*Variations) UnmarshalYAML

func (variations *Variations) UnmarshalYAML(n *yaml.Node) error