workflow

type Command func(ctx Context)

type Condition = any

type ConditionFunc = func(ctx Context) (bool, error)

type Context struct {
	context.Context

	// Workflow is the current workflow.
	Workflow Workflow
	// WorkflowRun describes the current invocation.
	WorkflowRun models.WorkflowRun
	// Job is the current job.
	Job      Job
	JobIndex int
	// Step is the current step.
	Step      Step
	StepIndex int

	// Outputs holds the outputs of steps and jobs, mapped by their path.
	// Outputs should not be written directly, as they are managed by the workflow
	// runtime.
	// Example:
	//   ctx.Outputs["step.getManifests.manifests"]
	//   ctx.Outputs["jobs.oci.step.getManifests.manifests"]
	Outputs map[string]any

	// Error holds any current error of the context.
	Error error
}

type Input = any

type Job struct {
	// ID is an optional ID by which to reference any outputs created by the job's
	// steps.
	ID string
	// Name is a human-readable name of the job.
	Name string
	// Steps holds all the steps that are run as part of the job.
	Steps []Step
	// DependsOn optionally holds the ids of jobs that must complete for this job
	// to run.
	// Jobs will not run if one of its dependencies fail.
	DependsOn []string
	// If holds a [Condition] that must pass for this job to run.
	If Condition
}

type Ref struct {
	Key string
}

type Step struct {
	ID   string
	Name string

	// Inputs holds a map of named inputs that can be used by the step.
	Inputs map[string]Input

	Main func(ctx Context) (Command, error)
	If   Condition

	Post   func(ctx Context) error
	PostIf Condition
}

type StepFunc func(ctx Context) (Command, error)

type Workflow struct {
	// Name is the human-readable name of the workflow.
	Name string
	// Jobs holds all the jobs that the workflow should run.
	// Jobs are started in the order defined by their dependencies.
	Jobs []Job
}