builder

package

v0.8.19-rc-0 Latest Latest Go to latest Published: Sep 11, 2026 License: MPL-2.0 Imports: 52 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/EarthBuild/earthbuild

Links

Open Source Insights

Documentation ¶

Overview ¶

Package builder orchestrates the top-level resolution and execution of earth targets and commands.

Index ¶

Constants
type BuildOpt
type Builder
- func NewBuilder(opt Opt) (*Builder, error)
- func (b *Builder) BuildTarget(ctx context.Context, target domain.Target, opt BuildOpt) (*states.MultiTarget, error)
type Opt
type ProjectAdder

Constants ¶

View Source

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BuildOpt ¶

type BuildOpt struct {
	ProjectAdder               ProjectAdder
	OnlyArtifact               *domain.Artifact
	Logbus                     *logbus.Bus
	LocalArtifactWhiteList     *gatewaycrafter.LocalArtifactWhiteList
	PlatformResolver           *platutil.Resolver
	BuiltinArgs                variables.DefaultArgs
	OnlyArtifactDestPath       string
	Runner                     string
	OnlyFinalTargetImages      bool
	NoOutput                   bool
	EnableGatewayClientLogging bool
	CI                         bool
	GlobalWaitBlockFtr         bool
	Push                       bool
	PrintPhases                bool
	AllowPrivileged            bool
}

BuildOpt is a collection of build options.

type Builder ¶

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

Builder executes earth builds.

func NewBuilder ¶

func NewBuilder(opt Opt) (*Builder, error)

NewBuilder returns a new earth 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 earth target.

type Opt ¶

type Opt struct {
	BuildkitSkipper                       bk.BuildkitSkipper
	ContainerFrontend                     containerutil.ContainerFrontend
	Parallelism                           semutil.Semaphore
	OverridingVars                        *variables.Scope
	GitLookup                             *buildcontext.GitLookup
	BuildContextProvider                  *provider.BuildContextProvider
	InternalSecretStore                   *secretprovider.MutableMapStore
	CacheImports                          *states.CacheImports
	BkClient                              *client.Client
	Log                                   *conslogging.ConsoleLogger
	LogBusSolverMonitor                   *solvermon.SolverMonitor
	CleanCollection                       *cleanup.Collection
	GitImage                              string
	DarwinProxyImage                      string
	MaxCacheExport                        string
	GitLFSInclude                         string
	LocalRegistryAddr                     string
	GitBranchOverride                     string
	FeatureFlagOverrides                  string
	CacheExport                           string
	Enttlmnts                             []entitlements.Entitlement
	Attachables                           []session.Attachable
	DarwinProxyWait                       time.Duration
	GitLogLevel                           buildkitgitutil.GitLogLevel
	ImageResolveMode                      llb.ResolveMode
	Verbose                               bool
	DisableRemoteRegistryProxy            bool
	NoCache                               bool
	ParallelConversion                    bool
	UseFakeDep                            bool
	InteractiveDebugging                  bool
	InteractiveDebuggingDebugLevelLogging bool
	DisableNoOutputUpdates                bool
	Strict                                bool
	UseInlineCache                        bool
	SaveInlineCache                       bool
	NoAutoSkip                            bool
}

Opt represent builder options.

type ProjectAdder ¶

type ProjectAdder interface {
	AddProject(org, project string)
}

ProjectAdder provides an interface for adding projects.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL