vai

type CommandOutputs ¶

type CommandOutputs map[string]map[string]any

CommandOutputs is a map of step IDs to their outputs.

type Step ¶

type Step struct {
	// Run is the command/script to run
	Run string `json:"run,omitempty"`
	// Eval is an expression to evaluate with tengo
	Eval string `json:"eval,omitempty"`
	// Uses is a reference to another task
	Uses string `json:"uses,omitempty"`
	// With is a map of additional parameters for the step/task call
	With `json:"with,omitempty"`
	// ID is a unique identifier for the step
	ID string `json:"id,omitempty"`
	// Name is a human-readable name for the step
	Name string `json:"name,omitempty"`
}

Step is a single step in a task

While a step can have any combination of `run`, `eval`, and `uses` fields, only one of them should be set at a time.

This is enforced by JSON schema validation.

func (Step) JSONSchemaExtend(schema *jsonschema.Schema)

type Task ¶

type Task []Step

Task is a list of steps

type With ¶

type With map[string]WithEntry

With is a map of string keys and WithEntry values used to pass parameters to called tasks and within steps

Each key will be mapped to an equivalent environment variable when the command is run. eg. `with: {foo: bar}` will be passed as `foo=bar` to the command.

func PerformLookups(ctx context.Context, outer, local With, previousOutputs CommandOutputs) (With, error)

type WithEntry ¶

type WithEntry any

WithEntry is a single entry in a With map

type Workflow ¶

type Workflow map[string]Task

Workflow is a map of tasks, where the key is the task name

This is the main structure that represents `vai.yaml` and other vai workflow files

func Read(r io.Reader) (Workflow, error)

func ReadAndValidate(r io.Reader) (Workflow, error)

func (wf Workflow) Find(call string) (Task, bool)

func (wf Workflow) OrderedTaskNames() []string