maru2

func ExecuteBuiltin ¶

func ExecuteBuiltin(ctx context.Context, step v1.Step, with schema.With, previousOutputs CommandOutputs, dry bool) (map[string]any, error)

ExecuteBuiltin dispatches to registered builtin tasks (builtin:echo, builtin:fetch)

Strips the "builtin:" prefix, renders templates in the With map, then delegates to the appropriate builtin's Execute method

func Fetch ¶

func Fetch(ctx context.Context, svc *uses.FetcherService, uri *url.URL) (v1.Workflow, error)

Fetch downloads and validates a workflow from a remote or local source

Supports multiple fetcher types (GitHub, GitLab, OCI, HTTP, local files) with automatic fetcher selection based on URL scheme and configuration

func FetchAll ¶

func FetchAll(ctx context.Context, svc *uses.FetcherService, wf v1.Workflow, src *url.URL) error

FetchAll recursively downloads all remote workflow dependencies

Scans the workflow for uses: references, resolves URLs relative to the source, and pre-fetches all dependencies into the cache for offline execution

func ListAllLocal ¶

func ListAllLocal(ctx context.Context, src *url.URL, fsys afero.Fs) ([]string, error)

ListAllLocal recursively discovers all local file dependencies in a workflow tree

Scans file:// workflows for local uses: references, validates them, and returns the complete list of local files needed for execution

func MergeWithAndParams ¶

func MergeWithAndParams(ctx context.Context, with schema.With, params v1.InputMap) (schema.With, error)

MergeWithAndParams merges runtime inputs with parameter definitions

Resolves defaults, environment variables, validates inputs with regex, enforces required parameters, and handles type casting

Resolution priority: provided > default-from-env > default > error if required

func ParseOutput ¶

func ParseOutput(r io.ReadSeeker) (map[string]string, error)

ParseOutput parses the output file of a step

Matches behavior of GitHub Actions.

https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings

func Publish ¶

func Publish(ctx context.Context, dst *remote.Repository, entrypoints []string) error

Publish packages workflows as OCI artifacts in a container registry

Fetches all remote imports, stores them in a temp directory, then pushes the complete workflow bundle to the OCI registry for distribution

func RegisterWhichShortcut ¶

func RegisterWhichShortcut(short, long string)

RegisterWhichShortcut registers a key-value pair to be expanded during the "which" text template function

func Run ¶

func Run(
	parent context.Context,
	svc *uses.FetcherService,
	wf v1.Workflow,
	taskName string,
	outer schema.With,
	origin *url.URL,
	ro RuntimeOptions,
) (map[string]any, error)

Run is the main event loop in maru2

It is implemented as a recursive function instead of a DAG for simplicity (debatable)

Run follows the following general pattern:

1. Find the called task in the provided workflow

2. Merge the provided inputs w/ the default workflow inputs

3. Create a child context to listen for SIGINT

4. For each step in the task:

   4a. Compile `if` conditionals and determine if the step should run

   4b. Soft reset the context if a previous step was cancelled, timed out, etc...

   4c. Wrap the current context in a timeout if `timeout` was set

   4d. If `uses` is set, resolve & fetch, then goto Step 1

   4e. If `run` is set, render the script with the provided inputs / environment

   4f. Parse the outputs from the script and store for later step retrieval

   4g. Add tracing if there was an error

5. Return the final step's output and the first error encountered

func ShouldRun ¶

func ShouldRun(ctx context.Context, expression string, err error, with schema.With, previousOutputs CommandOutputs, dry bool) (bool, error)

ShouldRun evaluates if expressions using the expr engine

Provides built-in functions: failure(), always(), cancelled(), input("name"), from("step-id", "key")

Returns false for failed steps when no expression is provided

func TemplateString ¶

func TemplateString(ctx context.Context, str string, with schema.With, previousOutputs CommandOutputs, dry bool) (string, error)

TemplateString expands templates in str using Go's text/template engine

In dry run mode, missing inputs and outputs are rendered with special markers

func TemplateWithMap ¶

func TemplateWithMap(ctx context.Context, withMap schema.With, input schema.With, previousOutputs CommandOutputs, dry bool) (schema.With, error)

TemplateWithMap recursively expands templates in all string values within a map

Handles nested maps and slices while preserving non-string values

func WorkflowSchema ¶

func WorkflowSchema(version string) *jsonschema.Schema

WorkflowSchema generates JSON Schema for workflow validation

Returns version-specific schema for v0/v1, or a meta-schema with conditional validation that automatically selects the correct version based on schema-version field