task

Documentation

Index

• func ValidateInputs(data map[string]string, t *Task) []error
• type Registry
  • func NewRegistry(opts options.Opts) *Registry
  • func (tr *Registry) GetTasks() []*Task
  • func (tr *Registry) ReadAll(taskFiles []string) error
  • func (tr *Registry) ReadTasks(taskFile string) error
  • func (tr *Registry) Stop()
• type Task
  • func (tw *Task) Actions() []action.Action
  • func (tw *Task) AddPreCloneFilters(f ...filter.Filter)
  • func (tw *Task) CalcAutoMergeAfter() time.Duration
  • func (tw *Task) Checksum() string
  • func (tw *Task) FiltersPostClone() []filter.Filter
  • func (tw *Task) FiltersPreClone() []filter.Filter
  • func (tw *Task) HasFilters() bool
  • func (tw *Task) HasReachMaxOpenPRs() bool
  • func (tw *Task) HasReachedChangeLimit() bool
  • func (tw *Task) IncChangeLimitCount()
  • func (tw *Task) IncOpenPRsCount()
  • func (tw *Task) InputData() map[string]string
  • func (tw *Task) OnPrClosed(ctx context.Context) error
  • func (tw *Task) OnPrCreated(ctx context.Context) error
  • func (tw *Task) OnPrMerged(ctx context.Context) error
  • func (tw *Task) Path() string
  • func (tw *Task) RenderBranchName(data template.Data) (string, error)
  • func (tw *Task) RenderPrTitle(data template.Data) (string, error)
  • func (tw *Task) SetInputs(cliInputs map[string]string) error
  • func (tw *Task) Stop()

Functions

func ValidateInputs

func ValidateInputs(data map[string]string, t *Task) []error

ValidateInputs validates the values in data. It returns a list of errors where each error details a failed validation.

Types

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

Registry contains all tasks.

func NewRegistry

func NewRegistry(opts options.Opts) *Registry

func (*Registry) GetTasks

func (tr *Registry) GetTasks() []*Task

GetTasks returns all tasks registered with the Registry. Should be called only after ReadAll() has been called at least once.

func (*Registry) ReadAll

func (tr *Registry) ReadAll(taskFiles []string) error

ReadAll takes a list of paths to task files and reads all tasks from the files.

func (*Registry) ReadTasks

func (tr *Registry) ReadTasks(taskFile string) error

ReadTasks reads all tasks defined in taskFile and adds them to the registry.

func (*Registry) Stop

func (tr *Registry) Stop()

Stop notifies every task that this Registry is being stopped. This usually happens at the end of a run. Every task can then execute code to clean itself up.

type Task

type Task struct {
	schema.Task
	// contains filtered or unexported fields
}

func (*Task) Actions

func (tw *Task) Actions() []action.Action

func (*Task) AddPreCloneFilters

func (tw *Task) AddPreCloneFilters(f ...filter.Filter)

func (*Task) CalcAutoMergeAfter

func (tw *Task) CalcAutoMergeAfter() time.Duration

func (*Task) Checksum

func (tw *Task) Checksum() string

func (*Task) FiltersPostClone

func (tw *Task) FiltersPostClone() []filter.Filter

func (*Task) FiltersPreClone

func (tw *Task) FiltersPreClone() []filter.Filter

func (*Task) HasFilters

func (tw *Task) HasFilters() bool

func (*Task) HasReachMaxOpenPRs

func (tw *Task) HasReachMaxOpenPRs() bool

func (*Task) HasReachedChangeLimit

func (tw *Task) HasReachedChangeLimit() bool

func (*Task) IncChangeLimitCount

func (tw *Task) IncChangeLimitCount()

func (*Task) IncOpenPRsCount

func (tw *Task) IncOpenPRsCount()

func (*Task) InputData

func (tw *Task) InputData() map[string]string

InputData returns a map where every key is an input defined by the task and every value is what has been set via the command-line for that key.

func (*Task) OnPrClosed

func (tw *Task) OnPrClosed(ctx context.Context) error

func (*Task) OnPrCreated

func (tw *Task) OnPrCreated(ctx context.Context) error

func (*Task) OnPrMerged

func (tw *Task) OnPrMerged(ctx context.Context) error

func (*Task) Path

func (tw *Task) Path() string

func (*Task) RenderBranchName

func (tw *Task) RenderBranchName(data template.Data) (string, error)

func (*Task) RenderPrTitle

func (tw *Task) RenderPrTitle(data template.Data) (string, error)

func (*Task) SetInputs

func (tw *Task) SetInputs(cliInputs map[string]string) error

SetInputs takes inputs supplied via the command-line and stores them for later processing. It returns an error if an expected input isn't supplied and no default value for the input has been set.

func (*Task) Stop

func (tw *Task) Stop()