builder

Documentation

Index

• Constants
• func NewBuildError(err error, vertexLog string) error
• type BuildError
  • func (e *BuildError) Error() string
  • func (e *BuildError) Unwrap() error
  • func (e *BuildError) VertexLog() string
• type BuildOpt
• type Builder
  • func NewBuilder(ctx context.Context, opt Opt) (*Builder, error)
  • func (b *Builder) BuildTarget(ctx context.Context, target domain.Target, opt BuildOpt) (*states.MultiTarget, error)
• type Opt

Constants

const (
	// PhaseInit is the phase text for the init phase.
	PhaseInit = "1. Init 🚀"
	// PhaseBuild is the phase text for the build phase.
	PhaseBuild = "2. Build 🔧"
	// PhasePush is the phase text for the push phase.
	PhasePush = "3. Push ⏫"
	// PhaseOutput is the phase text for the output phase.
	PhaseOutput = "4. Local Output 🎁"
)

Functions

func NewBuildError

func NewBuildError(err error, vertexLog string) error

NewBuildError creates a new BuildError with the additional output log of the command that failed

Types

type BuildError

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

BuildError contains an BuildError and log

func (*BuildError) Error

func (e *BuildError) Error() string

BuildError formats the BuildError as a string, ommitting the vertex log

func (*BuildError) Unwrap

func (e *BuildError) Unwrap() error

Unwrap returns the wrapped error

func (*BuildError) VertexLog

func (e *BuildError) VertexLog() string

VertexLog returns the vertex log associated with the error

type BuildOpt

type BuildOpt struct {
	PlatformResolver           *platutil.Resolver
	AllowPrivileged            bool
	PrintPhases                bool
	Push                       bool
	NoOutput                   bool
	OnlyFinalTargetImages      bool
	OnlyArtifact               *domain.Artifact
	OnlyArtifactDestPath       string
	EnableGatewayClientLogging bool
	BuiltinArgs                variables.DefaultArgs
}

BuildOpt is a collection of build options.

type Builder

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

Builder executes Earthly builds.

func NewBuilder

func NewBuilder(ctx context.Context, opt Opt) (*Builder, error)

NewBuilder returns a new earthly Builder.

func (*Builder) BuildTarget

func (b *Builder) BuildTarget(ctx context.Context, target domain.Target, opt BuildOpt) (*states.MultiTarget, error)

BuildTarget executes the build of a given Earthly target.

type Opt

type Opt struct {
	SessionID              string
	BkClient               *client.Client
	Console                conslogging.ConsoleLogger
	Verbose                bool
	Attachables            []session.Attachable
	Enttlmnts              []entitlements.Entitlement
	NoCache                bool
	CacheImports           *states.CacheImports
	CacheExport            string
	MaxCacheExport         string
	UseInlineCache         bool
	SaveInlineCache        bool
	ImageResolveMode       llb.ResolveMode
	CleanCollection        *cleanup.Collection
	OverridingVars         *variables.Scope
	BuildContextProvider   *provider.BuildContextProvider
	GitLookup              *buildcontext.GitLookup
	UseFakeDep             bool
	Strict                 bool
	DisableNoOutputUpdates bool
	ParallelConversion     bool
	Parallelism            semutil.Semaphore
	LocalRegistryAddr      string
	FeatureFlagOverrides   string
	ContainerFrontend      containerutil.ContainerFrontend
	InternalSecretStore    *secretprovider.MutableMapStore
}

Opt represent builder options.