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
- API
  
  Reference documentation for the pkg.go.dev API
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 module

Go to main page

Versions in this module

v0

v0.2.0

Jun 14, 2026

Changes in this version

+ const ActionRevokeApprove

+ const ActionWithdraw

+ var ErrNothingToRevoke = errors.New("workflow: operator has no live approval to revoke in the current round")

+ var ErrRevokeNotAllowed = errors.New("workflow: approval cannot be revoked for this stage type")

type Service

+ func (s *Service) RevokeApprove(ctx context.Context, applicationID, operatorID, comment string) (Application, ReviewLog, error)

+ func (s *Service) Withdraw(ctx context.Context, applicationID, comment string) (Application, ReviewLog, error)

type WorkflowEngine

+ func (e *WorkflowEngine) CanRevokeApprove(app Application, template WorkflowTemplate, operatorID string, ...) bool

+ func (e *WorkflowEngine) CanWithdraw(app Application, userID string) bool

+ func (e *WorkflowEngine) RevokeApprove(app Application, template WorkflowTemplate, operatorID string, comment string, ...) (Application, ReviewLog, error)

+ func (e *WorkflowEngine) Withdraw(app Application, template WorkflowTemplate, comment string) (Application, ReviewLog, error)

v0.1.0

May 18, 2026

Changes in this version

+ const ActionApprove

+ const ActionRejectClose

+ const ActionReturn

+ const ActionSubmit

+ const ReturnModeDirect

+ const ReturnModeStrict

+ const ReviewTypeAll

+ const ReviewTypeSingle

+ const StatusApproved

+ const StatusDraft

+ const StatusInReview

+ const StatusRejectedClosed

+ const StatusReturned

+ var ErrAlreadyApproved = errors.New("workflow: operator has already approved in current round")

+ var ErrCommentRequired = errors.New("workflow: comment is required for this action")

+ var ErrInvalidStatus = errors.New("workflow: invalid application status for this operation")

+ var ErrInvalidTemplate = errors.New("workflow: invalid template configuration")

+ var ErrNoPermission = errors.New("workflow: operator has no permission to perform this action")

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

+ var ErrStaleReturnStage = errors.New("workflow: stored return-stage index is out of range for the current template")

+ var ErrTemplateEmpty = errors.New("workflow: template has no stages")

+ var ErrTemplateMismatch = errors.New("workflow: template does not match application")

+ type Application struct

+ CurrentStageIndex int

+ ID string

+ OwnerID string

+ ReturnStageIndex int

+ Status string

+ WorkflowID string

+ type ApproverResolver interface

+ Resolve func(app Application, stage WorkflowStage) ([]string, error)

+ type ApproverResolverFunc func(app Application, stage WorkflowStage) ([]string, error)

+ func (f ApproverResolverFunc) Resolve(app Application, stage WorkflowStage) ([]string, error)

+ type ReviewLog struct

+ Action string

+ ApplicationID string

+ Comment string

+ CreatedAt time.Time

+ ID string

+ OperatorID string

+ StageIndex int

+ type Service struct

+ Engine *WorkflowEngine

+ Store Store

+ func NewService(store Store, engine *WorkflowEngine) *Service

+ func (s *Service) Approve(ctx context.Context, applicationID, operatorID string) (Application, ReviewLog, error)

+ func (s *Service) CreateDraft(ctx context.Context, app Application) error

+ func (s *Service) GetApplication(ctx context.Context, applicationID string) (Application, error)

+ func (s *Service) ListLogs(ctx context.Context, applicationID string) ([]ReviewLog, error)

+ func (s *Service) RejectClose(ctx context.Context, applicationID, operatorID, comment string) (Application, ReviewLog, error)

+ func (s *Service) Resubmit(ctx context.Context, applicationID string) (Application, ReviewLog, error)

+ func (s *Service) Return(ctx context.Context, applicationID, operatorID, comment string) (Application, ReviewLog, error)

+ func (s *Service) SaveTemplate(ctx context.Context, tpl WorkflowTemplate) error

+ func (s *Service) Submit(ctx context.Context, applicationID string) (Application, ReviewLog, error)

+ type Store interface

+ AppendLog func(ctx context.Context, l ReviewLog) error

+ GetApplication func(ctx context.Context, id string) (Application, error)

+ GetTemplate func(ctx context.Context, id string) (WorkflowTemplate, error)

+ ListInFlightApplications func(ctx context.Context, workflowID string) ([]Application, error)

+ ListLogs func(ctx context.Context, applicationID string) ([]ReviewLog, error)

+ SaveApplication func(ctx context.Context, a Application) error

+ SaveTemplate func(ctx context.Context, t WorkflowTemplate) error

+ Transact func(ctx context.Context, fn func(s Store) error) error

+ type WorkflowEngine struct

+ Clock func() time.Time

+ IDGenerator func() string

+ Resolver ApproverResolver

+ func NewEngine() *WorkflowEngine

+ func (e *WorkflowEngine) Approve(app Application, template WorkflowTemplate, operatorID string, ...) (Application, ReviewLog, error)

+ func (e *WorkflowEngine) CanEditForm(app Application, userID string) bool

+ func (e *WorkflowEngine) CanResubmit(app Application, userID string) bool

+ func (e *WorkflowEngine) CanReview(app Application, template WorkflowTemplate, userID string) bool

+ func (e *WorkflowEngine) CanView(app Application, template WorkflowTemplate, userID string) bool

+ func (e *WorkflowEngine) RejectClose(app Application, template WorkflowTemplate, operatorID string, comment string) (Application, ReviewLog, error)

+ func (e *WorkflowEngine) ResetToFirstSubmit(app Application, template WorkflowTemplate) (Application, ReviewLog, error)

+ func (e *WorkflowEngine) Resubmit(app Application, template WorkflowTemplate) (Application, ReviewLog, error)

+ func (e *WorkflowEngine) Return(app Application, template WorkflowTemplate, operatorID string, comment string) (Application, ReviewLog, error)

+ func (e *WorkflowEngine) Submit(app Application, template WorkflowTemplate) (Application, ReviewLog, error)

+ type WorkflowStage struct

+ ApproverIDs []string

+ ReviewType string

+ StageIndex int

+ type WorkflowTemplate struct

+ ID string

+ ReturnMode string

+ Stages []WorkflowStage