runner

type IContext interface {
	// The root directory of the repository.
	Root() string

	// The Git context initialized at the root of the repository.
	Git() git.Context

	// The logger object.
	Log() log.ILog

	// On which component the runner executes.
	// Should not be able to change things in here.
	Component() *component.Component

	// On which target and step the runner executes.
	Target() target.ID

	// On which step the runner executes.
	Step() step.Index

	// The toolchain this runner runs in.
	Toolchain() string
}

type IRunner interface {
	ID() RegisterID
	Run(ctx IContext) error
}

type ISettings interface{}

type RegisterFunc = func(
	key RegisterKey,
	data ...RunnerData,
)

type RegisterID = string

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

type RunnerData struct {
	// The Creator function for the runner.
	// The `runnerConfig` is the unmarshalled config from the
	// `component.Config`.
	Creator func(runnerConfig any) (IRunner, error)

	// The config unmarshaller for additional `config:` section
	// (can be nil if no config should be parsed).
	// The result will be passed to the creator.
	RunnerConfigUnmarshal step.RunnerConfigUnmarshaller

	// The default toolchain to use if not specified in config.
	DefaultToolchain string
}