Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

workflow

package

Go to main page

Versions in this module

v0

v0.9.7-RC01

Sep 29, 2025

v0.9.6-RC03

Sep 25, 2025

v0.9.5

Sep 19, 2025

v0.9.5-RC02

Sep 19, 2025

v0.9.5-RC01

Sep 16, 2025

v0.9.4

Sep 15, 2025

Changes in this version

+ var ErrBreakStages = errors.New("break stages")

+ var ErrExitWorkflow = errors.New("exit")

+ var ErrNoConsole = errors.New("no console")

+ var ErrNotFound = errors.New("not found")

+ var ErrSkipStage = errors.New("skip stage")

+ var ErrSkipStep = errors.New("skip step")

+ func GetArg[T any](sh Snapshot, stepName, key string) (T, error)

+ func NoConsoleError(err error) error

+ func RunWithBackoff(ctx context.Context, w *Workflow, stage *Stage, step *Step) error

+ func RunWithLinear(ctx context.Context, w *Workflow, stage *Stage, step *Step) error

+ type FailData struct

+ FailedStageName string

+ FailedStepName string

+ type RetryPolicyFn func(context.Context, *Workflow, *Stage, *Step) error

+ type Snapshot struct

+ StepsStates []*StepState

+ WorkflowState WorkflowState

+ type Stage struct

+ AfterFn func(context.Context, *Stage) error

+ BeforeFn func(context.Context, *Stage) error

+ Name string

+ Steps []*Step

+ func NewStage(name string, opts ...StageOption) *Stage

+ type StageOption func(*Stage)

+ func WithStageAfterFn(fn func(context.Context, *Stage) error) StageOption

+ func WithStageBeforeFn(fn func(context.Context, *Stage) error) StageOption

+ func WithStageSteps(steps []*Step) StageOption

+ type Step struct

+ AfterFn func(context.Context, *Step) error

+ Args any

+ BeforeFn func(context.Context, *Step) error

+ FinishWorkflow bool

+ Func StepFunc

+ Kind string

+ MaxRetries int

+ Name string

+ RetryPolicy RetryPolicyFn

+ State *StepState

+ Timeout time.Duration

+ func NewStep(name string, fn StepFunc, opts ...StepOption) *Step

+ func (s *Step) SetAfterFn(value func(context.Context, *Step) error) *Step

+ func (s *Step) SetBeforeFn(value func(context.Context, *Step) error) *Step

+ func (s *Step) SetFunc(value StepFunc) *Step

+ func (s *Step) SetMaxRetries(value int) *Step

+ func (s *Step) SetRetryPolicy(value RetryPolicyFn) *Step

+ func (s *Step) SetStepFinishWorkflow(value bool) *Step

+ func (s *Step) SetTimeout(value time.Duration) *Step

+ type StepFunc func(ctx context.Context, workflow *Workflow, stage *Stage, step *Step) error

+ type StepOption func(*Step)

+ func WithStepAfterFn(fn func(context.Context, *Step) error) StepOption

+ func WithStepArgs(args any) StepOption

+ func WithStepBeforeFn(fn func(context.Context, *Step) error) StepOption

+ func WithStepKind(k string) StepOption

+ func WithStepMaxRetries(r int) StepOption

+ func WithStepRetryPolicy(fn RetryPolicyFn) StepOption

+ func WithStepTimeout(d time.Duration) StepOption

+ type StepState struct

+ Args map[string]any

+ CurrentStage string

+ CurrentStep string

+ EndTime *time.Time

+ Error string

+ NextStage *string

+ NextStep *string

+ PreviousStage *string

+ PreviousStep *string

+ StartTime *time.Time

+ Status StepStatus

+ func NewStepState() *StepState

+ func (s *StepState) SetArg(key string, value any) (*StepState, error)

+ func (s *StepState) SetArgs(args map[string]any) (*StepState, error)

+ func (s *StepState) SetCurrentStage(stage string) *StepState

+ func (s *StepState) SetCurrentStep(step string) *StepState

+ func (s *StepState) SetEndTime(t time.Time) *StepState

+ func (s *StepState) SetError(err error) *StepState

+ func (s *StepState) SetNextStage(stage string) *StepState

+ func (s *StepState) SetNextStep(step string) *StepState

+ func (s *StepState) SetPreviousStage(stage string) *StepState

+ func (s *StepState) SetPreviousStep(step string) *StepState

+ func (s *StepState) SetStartTime(t time.Time) *StepState

+ func (s *StepState) SetStatus(status StepStatus) *StepState

+ type StepStatus string

+ const StepStatusCompleted

+ const StepStatusFailed

+ const StepStatusPending

+ const StepStatusProcessing

+ const StepStatusSkipped

+ const StepStatusSuspended

+ func AllStepStatuses() []StepStatus

+ func (s StepStatus) String() string

+ func (s StepStatus) Valid() bool

+ type Workflow struct

+ AfterAllStepsFn func(context.Context, *Workflow, *Stage, *Step) error

+ AfterFn func(context.Context, *Workflow) error

+ BeforeAllStepsFn func(context.Context, *Workflow, *Stage, *Step) error

+ BeforeFn func(context.Context, *Workflow) error

+ Debug bool

+ Name string

+ OnFailureFn func(context.Context, *Workflow, error) error

+ Stages []*Stage

+ State WorkflowState

+ func New(opts ...WorkflowOption) *Workflow

+ func (w *Workflow) CurrentStage() *Stage

+ func (w *Workflow) CurrentStep() *Step

+ func (w *Workflow) Debugf(format string, args ...any)

+ func (w *Workflow) Errorf(format string, args ...any)

+ func (w *Workflow) GetJSONSnapshot() string

+ func (w *Workflow) GetSnapshot() Snapshot

+ func (w *Workflow) Infof(format string, args ...any)

+ func (w *Workflow) Logger() logger

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

+ func (w *Workflow) SetAfterFn(fn func(context.Context, *Workflow) error) *Workflow

+ func (w *Workflow) SetBeforeAllStepsFn(fn func(context.Context, *Workflow, *Stage, *Step) error) *Workflow

+ func (w *Workflow) SetBeforeFn(fn func(context.Context, *Workflow) error) *Workflow

+ func (w *Workflow) SetDebug(debug bool) *Workflow

+ func (w *Workflow) SetJSONSnapshot(snapshot string) error

+ func (w *Workflow) SetLogger(l logger) *Workflow

+ func (w *Workflow) SetName(name string) *Workflow

+ func (w *Workflow) SetOnFailureFn(fn func(context.Context, *Workflow, error) error) *Workflow

+ func (w *Workflow) SetSkipError(skip bool) *Workflow

+ func (w *Workflow) SetSnapshot(snapshot Snapshot) error

+ func (w *Workflow) SetStages(stages []*Stage) *Workflow

+ func (w *Workflow) SetState(state WorkflowState) *Workflow

+ func (w *Workflow) StepStates() []*StepState

+ func (w *Workflow) Warnf(format string, args ...any)

+ type WorkflowOption func(*Workflow)

+ func WithAfterAllStepsFn(fn func(context.Context, *Workflow, *Stage, *Step) error) WorkflowOption

+ func WithAfterFn(fn func(context.Context, *Workflow) error) WorkflowOption

+ func WithBeforeAllStepsFn(fn func(context.Context, *Workflow, *Stage, *Step) error) WorkflowOption

+ func WithBeforeFn(fn func(context.Context, *Workflow) error) WorkflowOption

+ func WithDebug(d bool) WorkflowOption

+ func WithLogger(l logger) WorkflowOption

+ func WithName(n string) WorkflowOption

+ func WithOnFailureFn(fn func(context.Context, *Workflow, error) error) WorkflowOption

+ func WithState(s WorkflowState) WorkflowOption

+ type WorkflowState struct

+ CustomError json.RawMessage

+ Error string

+ IsCompleted bool

+ IsFailed bool

+ IsSuspended bool

+ NextStage string

+ NextStep string

+ func (w *WorkflowState) GetCustomError() json.RawMessage

+ func (w *WorkflowState) SetCompleted(value bool) *WorkflowState

+ func (w *WorkflowState) SetCustomError(value []byte) *WorkflowState

+ func (w *WorkflowState) SetError(err error) *WorkflowState

+ func (w *WorkflowState) SetErrorMsg(msg string) *WorkflowState

+ func (w *WorkflowState) SetFailed(value bool) *WorkflowState

+ func (w *WorkflowState) SetNextStage(stage string) *WorkflowState

+ func (w *WorkflowState) SetNextStep(step string) *WorkflowState

+ func (w *WorkflowState) SetSuspended(value bool) *WorkflowState

v0.9.4-RC05

Sep 9, 2025

v0.9.4-RC01

Sep 5, 2025

v0.9.3

Sep 3, 2025

v0.9.2

Sep 3, 2025

v0.9.1

Sep 1, 2025