v1

Documentation

Index

• Variables
• func GetAny[T any](ol OptionsList, key string) (T, error)
• func GetOptional[T any](o Options, key string) (T, error)
• func GetRequired[T any](o Options, key string) (T, error)
• type Config
• type Options
• type OptionsList
• type Pipeline
• type Statement

Variables

var (
	ErrNoValue   = errors.New("no value found for option")
	ErrWrongType = errors.New("wrong type for option")
)

Functions

func GetAny

func GetAny[T any](ol OptionsList, key string) (T, error)

GetAny retrieves the first matching value from a given OptionsList and returns ErrNoValue if nothing could be found.

func GetOptional

func GetOptional[T any](o Options, key string) (T, error)

GetOptional retrieves a value by a given key. It returns the zero value of T if the key could not be found.

func GetRequired

func GetRequired[T any](o Options, key string) (T, error)

GetRequired retrieves a value by a given key. It returns ErrNoValue if the key could not be found.

Types

type Config

type Config struct {
	OverwriteEntrypoint bool     `json:"overwrite-entrypoint"`
	Entrypoint          []string `json:"entrypoint"`
	Command             []string `json:"command"`
}

type Options

type Options map[string]any

type OptionsList

type OptionsList []Options

type Pipeline

type Pipeline struct {
	Base       string      `json:"base"`
	Statements []Statement `json:"statements"`
	Config     Config      `json:"config"`
}

type Statement

type Statement struct {
	ID        string   `json:"id"`
	Name      string   `json:"name"`
	Options   Options  `json:"options"`
	DependsOn []string `json:"depends-on"`
}