executor

package

v1.36.0 Latest Latest Go to latest Published: May 17, 2026 License: MIT Imports: 10 Imported by: 0

Details

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

Repository

github.com/sourceplane/orun

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func EnvironmentFromList(values []string) map[string]string
func EnvironmentList(env map[string]string) []string
func JobEnvironment(values map[string]interface{}) map[string]string
func MergeEnvironment(envs ...map[string]string) map[string]string
func NormalizeRunnerName(name string) string
func ResolveDockerImage(runsOn string) string
func Supported() []string
type ExecContext
type Executor
- func Get(name string) (Executor, error)
type JobFinalizer
type RuntimeContext

Constants ¶

View Source

const (
	DefaultDockerImage = "ubuntu:22.04"
	WorkspaceMountPath = "/workspace"
)

Variables ¶

This section is empty.

Functions ¶

func EnvironmentFromList ¶

func EnvironmentFromList(values []string) map[string]string

func EnvironmentList ¶

func EnvironmentList(env map[string]string) []string

func JobEnvironment ¶

func JobEnvironment(values map[string]interface{}) map[string]string

func MergeEnvironment ¶

func MergeEnvironment(envs ...map[string]string) map[string]string

func NormalizeRunnerName ¶

func NormalizeRunnerName(name string) string

func ResolveDockerImage ¶

func ResolveDockerImage(runsOn string) string

func Supported ¶

func Supported() []string

Types ¶

type ExecContext ¶

type ExecContext struct {
	Context            context.Context
	WorkspaceDir       string
	WorkDir            string
	UseWorkDirOverride bool
	BaseEnv            map[string]string
	JobEnv             map[string]string
	StepEnv            map[string]string
	Env                map[string]string
	Runtime            RuntimeContext
	Stdout             io.Writer
	Stderr             io.Writer
	DryRun             bool
}

ExecContext carries runtime settings for a single executor invocation.

type Executor ¶

type Executor interface {
	Name() string
	Prepare(ctx ExecContext) error
	RunStep(ctx ExecContext, job model.PlanJob, step model.PlanStep) (output string, err error)
	Cleanup(ctx ExecContext) error
}

Executor runs plan steps using a specific backend.

func Get ¶

func Get(name string) (Executor, error)

type JobFinalizer ¶

type JobFinalizer interface {
	FinalizeJob(ctx ExecContext, job model.PlanJob) (output string, err error)
}

JobFinalizer is implemented by executors that need job-level cleanup or post-step handling.

type RuntimeContext ¶

type RuntimeContext struct {
	Runner      string
	Environment string
}

RuntimeContext captures the selected execution backend and environment class.

Source Files ¶

View all Source files

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