workflow

Aug 8, 2026

Changes in this version

+ var ErrBuilderFrozen = errors.New("workflow: builder is frozen")

+ var ErrDuplicateDep = errors.New("workflow: duplicate dependency")

+ var ErrInvalidName = errors.New("workflow: invalid step name")

+ var ErrInvalidOption = errors.New("workflow: invalid option")

+ var ErrNilContext = errors.New("workflow: nil context")

+ type Builder struct

+ func (b *Builder) Build() (*Workflow, error)

+ func (b *Builder) Job(name string, job cron.Job, opts ...StepOption) Output[Unit]

+ func (b *Builder) MustBuild() *Workflow

+ func (b *Builder) Step[T any](name string, fn func(context.Context, Inputs) (T, error), opts ...StepOption) Output[T]

type Execution

+ func (e *Execution) Error(name string) error

+ func (e *Execution) Get[T any](output Output[T]) (T, bool)

+ func (e *Execution) Result(name string) (Result, bool)

+ func (e *Execution) Step(name string) (StepReport, bool)

type Inputs

+ func (in Inputs) Get[T any](output Output[T]) (T, bool)

+ type Option func(*builderConfig) error

+ func WithMaxParallelism(limit int) Option

+ type Output struct

+ func (o Output[T]) Name() string

+ type StepOption func(*step) error

+ func WithRetry(policy cron.RetryPolicy) StepOption

+ func WithTimeout(timeout time.Duration) StepOption

+ type Unit struct

type Workflow

+ func (w *Workflow) Execute(ctx context.Context) *Execution

Jul 7, 2026

Changes in this version

+ var ErrNilJob = errors.New("workflow: step has no job")

type Execution

+ Duration time.Duration

+ StartedAt time.Time

+ Steps map[string]StepReport

+ type Inputs map[string]any

type Step

+ Fn StepFunc

+ Retry cron.RetryPolicy

+ Timeout time.Duration

+ func NewStepFunc(name string, fn StepFunc, deps ...Dep) Step

+ func (s Step) WithRetry(p cron.RetryPolicy) Step

+ func (s Step) WithTimeout(d time.Duration) Step

+ type StepFunc func(ctx context.Context, in Inputs) (any, error)

+ type StepReport struct

+ Duration time.Duration

+ Err error

+ Output any

+ Result Result

+ StartedAt time.Time

Apr 28, 2026

Changes in this version

+ var ErrCycle = errors.New("workflow: cycle detected")

+ var ErrDuplicateStep = errors.New("workflow: duplicate step")

+ var ErrUnknownDep = errors.New("workflow: unknown dependency")

+ type Condition uint8

+ const OnComplete

+ const OnFailure

+ const OnSkipped

+ const OnSuccess

+ type ConfigError struct

+ Dep string

+ Err error

+ Step string

+ func (e *ConfigError) Error() string

+ func (e *ConfigError) Unwrap() error

+ type Dep struct

+ Name string

+ When Condition

+ func After(name string, when Condition) Dep

+ type Execution struct

+ Errors map[string]error

+ ID string

+ Results map[string]Result

+ func (e *Execution) Err() error

+ type Result uint8

+ const ResultFailure

+ const ResultPending

+ const ResultSkipped

+ const ResultSuccess

+ func (r Result) String() string

+ type Step struct

+ Deps []Dep

+ Job cron.Job

+ Name string

+ func NewStep(name string, job cron.Job, deps ...Dep) Step

+ type Workflow struct

+ func MustNew(steps ...Step) *Workflow

+ func New(steps ...Step) (*Workflow, error)

+ func (w *Workflow) Run(ctx context.Context) error

+ func (w *Workflow) WithOnComplete(cb func(*Execution)) *Workflow