hook

Documentation

Index

• func IsHaltingError(err error) bool
• func TasksTriggeredByEvent(config *v1.Config, repoID string, planID string, parentOp *v1.Operation, ...) ([]tasks.Task, error)
• type HookErrorFatal
  • func (e HookErrorFatal) Error() string
  • func (e HookErrorFatal) Unwrap() error
• type HookErrorRequestCancel
  • func (e HookErrorRequestCancel) Error() string
  • func (e HookErrorRequestCancel) Unwrap() error
• type HookErrorRetry
  • func (e HookErrorRetry) Error() string
• type RetryBackoffPolicy

Functions

func IsHaltingError

func IsHaltingError(err error) bool

IsHaltingError returns true if the error is a fatal error or a request to cancel the operation

func TasksTriggeredByEvent

func TasksTriggeredByEvent(config *v1.Config, repoID string, planID string, parentOp *v1.Operation, events []v1.Hook_Condition, vars interface{}) ([]tasks.Task, error)

Types

type HookErrorFatal

type HookErrorFatal struct {
	Err error
}

HookErrorFatal stops evaluation of subsequent hooks and will propagate to the hook flow's caller

func (HookErrorFatal) Error

func (e HookErrorFatal) Error() string

func (HookErrorFatal) Unwrap

func (e HookErrorFatal) Unwrap() error

type HookErrorRequestCancel

type HookErrorRequestCancel struct {
	Err error
}

HookErrorCancel requests that the calling operation cancel itself. It must be handled explicitly caller. Subsequent hooks will be skipped.

func (HookErrorRequestCancel) Error

func (e HookErrorRequestCancel) Error() string

func (HookErrorRequestCancel) Unwrap

func (e HookErrorRequestCancel) Unwrap() error

type HookErrorRetry

type HookErrorRetry struct {
	Err     error
	Backoff RetryBackoffPolicy
}

HookErrorRetry requests that the calling operation retry after a specified backoff duration

func (HookErrorRetry) Error

func (e HookErrorRetry) Error() string

type RetryBackoffPolicy

type RetryBackoffPolicy = func(attempt int) time.Duration