v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API.

Index

• type Dependency
• type Finalize
• type Install
• type Instruction
• type Options
• type Pkg
  • func NewPkg(file string, options *Options) (*Pkg, error)
• type Shell
• type Source
• type Step
• type Variant
  • func (v Variant) String() string
  • func (v *Variant) UnmarshalYAML(unmarshal func(interface{}) error) error

Types

type Dependency

type Dependency struct {
	Image string `yaml:"image,omitempty"`
	To    string `yaml:"to,omitempty"`
}

Dependency defined the dependency for a package.

type Finalize

type Finalize struct {
	From string `yaml:"from,omitempty"`
	To   string `yaml:"to,omitempty"`
}

Finalize the package.

type Install

type Install []string

Install configures the install packages.

type Instruction

type Instruction string

Instruction defines the instruction for a package.

type Options

type Options struct {
	CacheTo      string
	CacheFrom    string
	Organization string
	Platform     string
	Progress     string
	Push         string
	Registry     string
}

Options are the options for the build.

type Pkg

type Pkg struct {
	Options      *Options
	Name         string `yaml:"name,omitempty"`
	Bldr         string `yaml:"bldr,omitempty"`
	Shell        Shell  `yaml:"shell,omitempty"`
	Version      string
	Install      Install       `yaml:"install,omitempty"`
	Dependencies []*Dependency `yaml:"dependencies,omitempty"`
	Steps        []*Step       `yaml:"steps,omitempty"`
	Finalize     []*Finalize   `yaml:"finalize,omitempty"`
	Variant      Variant       `yaml:"variant,omitempty"`
}

Pkg defines the package to build.

func NewPkg

func NewPkg(file string, options *Options) (*Pkg, error)

NewPkg initializes a new Pkg.

type Shell

type Shell string

Shell is the shell to use for the package.

type Source

type Source struct {
	URL         string `yaml:"url,omitempty"`
	Destination string `yaml:"destination,omitempty"`
	SHA256      string `yaml:"sha256,omitempty"`
	SHA512      string `yaml:"sha512,omitempty"`
}

Source define a package source options.

type Step

type Step struct {
	Prepare *Instruction `yaml:"prepare,omitempty"`
	Build   *Instruction `yaml:"build,omitempty"`
	Install *Instruction `yaml:"install,omitempty"`
	Test    *Instruction `yaml:"test,omitempty"`
	Sources []*Source    `yaml:"sources,omitempty"`
}

Step defines a step in the build process.

type Variant

type Variant int

Variant defines the variant of the package.

const (
	// Alpine is the Alpine variant.
	Alpine Variant = iota
	// Scratch is the Scratch variant.
	Scratch
)

func (Variant) String

func (v Variant) String() string

func (*Variant) UnmarshalYAML

func (v *Variant) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.