compilerspec

Documentation

Index

• type BhojpurCompilationSpec
  • func NewBhojpurCompilationSpec(b []byte, p *types.Package) (*BhojpurCompilationSpec, error)
  • func (cs *BhojpurCompilationSpec) BuildSteps() []string
  • func (cs *BhojpurCompilationSpec) CopyRetrieves(dest string) error
  • func (cs *BhojpurCompilationSpec) EmptyPackage() bool
  • func (cs *BhojpurCompilationSpec) GetExcludes() []string
  • func (cs *BhojpurCompilationSpec) GetImage() string
  • func (cs *BhojpurCompilationSpec) GetIncludes() []string
  • func (cs *BhojpurCompilationSpec) GetOutputPath() string
  • func (cs *BhojpurCompilationSpec) GetPackage() *types.Package
  • func (cs *BhojpurCompilationSpec) GetPackageDir() string
  • func (cs *BhojpurCompilationSpec) GetPreBuildSteps() []string
  • func (cs *BhojpurCompilationSpec) GetRetrieve() []string
  • func (cs *BhojpurCompilationSpec) GetSeedImage() string
  • func (cs *BhojpurCompilationSpec) GetSourceAssertion() types.PackagesAssertions
  • func (cs *BhojpurCompilationSpec) HasImageSource() bool
  • func (cs *BhojpurCompilationSpec) Hash() (string, error)
  • func (cs *BhojpurCompilationSpec) ImageUnpack() bool
  • func (cs *BhojpurCompilationSpec) IsVirtual() bool
  • func (p *BhojpurCompilationSpec) Rel(s string) string
  • func (cs *BhojpurCompilationSpec) RenderBuildImage() (string, error)
  • func (cs *BhojpurCompilationSpec) RenderStepImage(image string) (string, error)
  • func (cs *BhojpurCompilationSpec) SetBuildOptions(b options.Compiler)
  • func (cs *BhojpurCompilationSpec) SetImage(s string)
  • func (cs *BhojpurCompilationSpec) SetOutputPath(s string)
  • func (cs *BhojpurCompilationSpec) SetPackageDir(s string)
  • func (cs *BhojpurCompilationSpec) SetSeedImage(s string)
  • func (cs *BhojpurCompilationSpec) SetSourceAssertion(as types.PackagesAssertions)
  • func (cs *BhojpurCompilationSpec) UnpackedPackage() bool
  • func (cs *BhojpurCompilationSpec) WriteBuildImageDefinition(path string) error
  • func (cs *BhojpurCompilationSpec) WriteStepImageDefinition(fromimage, path string) error
• type BhojpurCompilationspecs
  • func NewBhojpurCompilationspecs(s ...*BhojpurCompilationSpec) *BhojpurCompilationspecs
  • func (specs *BhojpurCompilationspecs) Add(s *BhojpurCompilationSpec)
  • func (specs *BhojpurCompilationspecs) All() []*BhojpurCompilationSpec
  • func (specs BhojpurCompilationspecs) Len() int
  • func (specs *BhojpurCompilationspecs) Remove(s *BhojpurCompilationspecs) *BhojpurCompilationspecs
  • func (specs *BhojpurCompilationspecs) Unique() *BhojpurCompilationspecs
• type CopyField
• type Signature

Types

type BhojpurCompilationSpec

type BhojpurCompilationSpec struct {
	Steps           []string                 `json:"steps"` // Are run inside a container and the result layer diff is saved
	Env             []string                 `json:"env"`
	Prelude         []string                 `json:"prelude"` // Are run inside the image which will be our builder
	Image           string                   `json:"image"`
	Seed            string                   `json:"seed"`
	Package         *types.Package           `json:"package"`
	SourceAssertion types.PackagesAssertions `json:"-"`
	PackageDir      string                   `json:"package_dir" yaml:"package_dir"`

	Retrieve []string `json:"retrieve"`

	OutputPath string   `json:"-"` // Where the build processfiles go
	Unpack     bool     `json:"unpack"`
	Includes   []string `json:"includes"`
	Excludes   []string `json:"excludes"`

	BuildOptions *options.Compiler `json:"build_options"`

	Copy []CopyField `json:"copy"`

	RequiresFinalImages bool `json:"requires_final_images" yaml:"requires_final_images"`
}

func NewBhojpurCompilationSpec

func NewBhojpurCompilationSpec(b []byte, p *types.Package) (*BhojpurCompilationSpec, error)

func (*BhojpurCompilationSpec) BuildSteps

func (cs *BhojpurCompilationSpec) BuildSteps() []string

func (*BhojpurCompilationSpec) CopyRetrieves

func (cs *BhojpurCompilationSpec) CopyRetrieves(dest string) error

func (*BhojpurCompilationSpec) EmptyPackage

func (cs *BhojpurCompilationSpec) EmptyPackage() bool

func (*BhojpurCompilationSpec) GetExcludes

func (cs *BhojpurCompilationSpec) GetExcludes() []string

func (*BhojpurCompilationSpec) GetImage

func (cs *BhojpurCompilationSpec) GetImage() string

func (*BhojpurCompilationSpec) GetIncludes

func (cs *BhojpurCompilationSpec) GetIncludes() []string

func (*BhojpurCompilationSpec) GetOutputPath

func (cs *BhojpurCompilationSpec) GetOutputPath() string

func (*BhojpurCompilationSpec) GetPackage

func (cs *BhojpurCompilationSpec) GetPackage() *types.Package

func (*BhojpurCompilationSpec) GetPackageDir

func (cs *BhojpurCompilationSpec) GetPackageDir() string

func (*BhojpurCompilationSpec) GetPreBuildSteps

func (cs *BhojpurCompilationSpec) GetPreBuildSteps() []string

func (*BhojpurCompilationSpec) GetRetrieve

func (cs *BhojpurCompilationSpec) GetRetrieve() []string

func (*BhojpurCompilationSpec) GetSeedImage

func (cs *BhojpurCompilationSpec) GetSeedImage() string

func (*BhojpurCompilationSpec) GetSourceAssertion

func (cs *BhojpurCompilationSpec) GetSourceAssertion() types.PackagesAssertions

func (*BhojpurCompilationSpec) HasImageSource

func (cs *BhojpurCompilationSpec) HasImageSource() bool

HasImageSource returns true when the compilation spec has an image source. a compilation spec has an image source when it depends on other packages or have a source image explictly supplied

func (*BhojpurCompilationSpec) Hash

func (cs *BhojpurCompilationSpec) Hash() (string, error)

func (*BhojpurCompilationSpec) ImageUnpack

func (cs *BhojpurCompilationSpec) ImageUnpack() bool

func (*BhojpurCompilationSpec) IsVirtual

func (cs *BhojpurCompilationSpec) IsVirtual() bool

IsVirtual returns true if the spec is virtual. A spec is virtual if the package is empty, and it has no image source to unpack from.

func (*BhojpurCompilationSpec) Rel

func (p *BhojpurCompilationSpec) Rel(s string) string

func (*BhojpurCompilationSpec) RenderBuildImage

func (cs *BhojpurCompilationSpec) RenderBuildImage() (string, error)

RenderBuildImage renders the dockerfile of the image used as a pre-build step

func (*BhojpurCompilationSpec) RenderStepImage

func (cs *BhojpurCompilationSpec) RenderStepImage(image string) (string, error)

RenderStepImage renders the dockerfile used for the image used for building the package

func (*BhojpurCompilationSpec) SetBuildOptions

func (cs *BhojpurCompilationSpec) SetBuildOptions(b options.Compiler)

func (*BhojpurCompilationSpec) SetImage

func (cs *BhojpurCompilationSpec) SetImage(s string)

func (*BhojpurCompilationSpec) SetOutputPath

func (cs *BhojpurCompilationSpec) SetOutputPath(s string)

func (*BhojpurCompilationSpec) SetPackageDir

func (cs *BhojpurCompilationSpec) SetPackageDir(s string)

func (*BhojpurCompilationSpec) SetSeedImage

func (cs *BhojpurCompilationSpec) SetSeedImage(s string)

func (*BhojpurCompilationSpec) SetSourceAssertion

func (cs *BhojpurCompilationSpec) SetSourceAssertion(as types.PackagesAssertions)

func (*BhojpurCompilationSpec) UnpackedPackage

func (cs *BhojpurCompilationSpec) UnpackedPackage() bool

func (*BhojpurCompilationSpec) WriteBuildImageDefinition

func (cs *BhojpurCompilationSpec) WriteBuildImageDefinition(path string) error

func (*BhojpurCompilationSpec) WriteStepImageDefinition

func (cs *BhojpurCompilationSpec) WriteStepImageDefinition(fromimage, path string) error

type BhojpurCompilationspecs

type BhojpurCompilationspecs []BhojpurCompilationSpec

func NewBhojpurCompilationspecs

func NewBhojpurCompilationspecs(s ...*BhojpurCompilationSpec) *BhojpurCompilationspecs

func (*BhojpurCompilationspecs) Add

func (specs *BhojpurCompilationspecs) Add(s *BhojpurCompilationSpec)

func (*BhojpurCompilationspecs) All

func (specs *BhojpurCompilationspecs) All() []*BhojpurCompilationSpec

func (BhojpurCompilationspecs) Len

func (specs BhojpurCompilationspecs) Len() int

func (*BhojpurCompilationspecs) Remove

func (specs *BhojpurCompilationspecs) Remove(s *BhojpurCompilationspecs) *BhojpurCompilationspecs

func (*BhojpurCompilationspecs) Unique

func (specs *BhojpurCompilationspecs) Unique() *BhojpurCompilationspecs

type CopyField

type CopyField struct {
	Package     *types.Package `json:"package"`
	Image       string         `json:"image"`
	Source      string         `json:"source"`
	Destination string         `json:"destination"`
}

type Signature

type Signature struct {
	Image               string
	Steps               []string
	PackageDir          string
	Prelude             []string
	Seed                string
	Env                 []string
	Retrieve            []string
	Unpack              bool
	Includes            []string
	Excludes            []string
	Copy                []CopyField
	Requires            types.Packages
	RequiresFinalImages bool
}

Signature is a portion of the spec that yields a signature for the hash