dockerfile

Documentation

Index

• type Dockerfile
  • func New(spec interface{}) (*Dockerfile, error)
  • func (df *Dockerfile) Changelog(from, to string) *result.Changelogs
  • func (d *Dockerfile) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)
  • func (df *Dockerfile) ReportConfig() interface{}
  • func (df *Dockerfile) Source(workingDir string, resultSource *result.Source) error
  • func (d *Dockerfile) Target(source string, scm scm.ScmHandler, dryRun bool, resultTarget *result.Target) (err error)
• type Spec

Types

type Dockerfile

type Dockerfile struct {
	// contains filtered or unexported fields
}

Dockerfile defines a resource of kind "dockerfile"

func New

func New(spec interface{}) (*Dockerfile, error)

New returns a reference to a newly initialized Dockerfile object from a Spec or an error if the provided Spec triggers a validation error.

func (*Dockerfile) Changelog

func (df *Dockerfile) Changelog(from, to string) *result.Changelogs

Changelog returns the changelog for this resource, or an empty string if not supported

func (*Dockerfile) Condition

func (d *Dockerfile) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)

Condition test if the Dockerfile contains the correct key/value

func (*Dockerfile) ReportConfig

func (df *Dockerfile) ReportConfig() interface{}

ReportConfig returns a cleaned version of the configuration to identify the resource without any sensitive information or context specific data.

func (*Dockerfile) Source

func (df *Dockerfile) Source(workingDir string, resultSource *result.Source) error

func (*Dockerfile) Target

func (d *Dockerfile) Target(source string, scm scm.ScmHandler, dryRun bool, resultTarget *result.Target) (err error)

Target updates a targeted Dockerfile from source control management system

type Spec

type Spec struct {
	// File specifies the dockerimage file path to use and is incompatible with Files
	File string `yaml:",omitempty"`
	// Files specifies the dockerimage file path(s) to use and is incompatible with File
	Files []string `yaml:",omitempty"`
	// Instruction specifies a DockerImage instruction such as ENV
	Instruction types.Instruction `yaml:"instruction,omitempty"`
	// Value specifies the value for a specified Dockerfile instruction.
	Value string `yaml:"value,omitempty"`
	// Stage can be used to further refined the scope
	// For Sources:
	// - If not defined, the last stage will be considered
	// For Condition and Targets:
	// - If not defined, all stages will be considered
	Stage string `yaml:"stage,omitempty"`
}

Spec defines a specification for a "dockerfile" resource parsed from an updatecli manifest file