templates

Documentation

Overview

Package templates defines a uimage template configuration file parser.

Index

• Variables
• type Command
• type Config
• type Templates
  • func Template() (*Templates, error)
  • func TemplateFrom(b []byte) (*Templates, error)
  • func TemplateFromFile(p string) (*Templates, error)
  • func (t *Templates) CommandsFor(names ...string) []string
  • func (t *Templates) Uimage(config string) ([]uimage.Modifier, error)

Variables

var ErrTemplateNotExist = errors.New("config template does not exist")

ErrTemplateNotExist is returned when the given config name did not exist.

Types

type Command

type Command struct {
	// Builder is bb, gbb, or binary.
	//
	// Defaults to bb if not given.
	Builder string

	// Commands are commands or template names.
	Commands []string
}

Command represents commands to build.

type Config

type Config struct {
	GOOS      string
	GOARCH    string
	BuildTags []string `yaml:"build_tags"`
	Commands  []Command
	Files     []string
	Init      *string
	Uinit     *string
	Shell     *string
}

Config is a mkuimage build configuration.

type Templates

type Templates struct {
	Configs map[string]Config

	// Commands defines a set of command template name -> commands to expand.
	Commands map[string][]string
}

Templates are a set of mkuimage build configs and command templates.

func Template

func Template() (*Templates, error)

Template parses the first file named .mkuimage.yaml in the current directory or any of its parents.

func TemplateFrom

func TemplateFrom(b []byte) (*Templates, error)

TemplateFrom parses a template from bytes.

func TemplateFromFile

func TemplateFromFile(p string) (*Templates, error)

TemplateFromFile parses a template from the given file.

func (*Templates) CommandsFor

func (t *Templates) CommandsFor(names ...string) []string

CommandsFor expands commands according to command templates.

func (*Templates) Uimage

func (t *Templates) Uimage(config string) ([]uimage.Modifier, error)

Uimage returns the uimage modifiers for the given templated config name.