app

Documentation

Index

• type JobState
• type Orchestrator
  • func NewOrchestrator() *Orchestrator
  • func (o *Orchestrator) Orchestrate(configFile string, options OrchestratorOptions) error
• type OrchestratorOptions
• type RunMode
• type Runner
  • func NewRunner(ctx context.Context, cfg *config.Config) *Runner
  • func (r *Runner) Cleanup(ctx context.Context) error
  • func (r *Runner) PrepareJobConfigs(options RunnerOptions) error
  • func (r *Runner) Run() error
• type RunnerOptions
• type StatusBoard
  • func NewStatusBoard(jobNames []string, out io.Writer) *StatusBoard
  • func (b *StatusBoard) Start()
  • func (b *StatusBoard) Stop()
  • func (b *StatusBoard) Update(name string, state JobState)

Types

type JobState

type JobState int

const (
	StatePending JobState = iota
	StateRunning
	StatePassed
	StateFailed
)

type Orchestrator

type Orchestrator struct{}

func NewOrchestrator

func NewOrchestrator() *Orchestrator

func (*Orchestrator) Orchestrate

func (o *Orchestrator) Orchestrate(configFile string, options OrchestratorOptions) error

type OrchestratorOptions

type OrchestratorOptions struct {
	JobNames       []string
	Stages         []string
	Remote         string
	Env            []string
	Parallel       bool
	ParallelStages bool
}

type RunMode

type RunMode int

const (
	ModeSequential RunMode = iota
	ModeParallel
	ModeParallelStages
)

type Runner

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

func NewRunner

func NewRunner(ctx context.Context, cfg *config.Config) *Runner

func (*Runner) Cleanup

func (r *Runner) Cleanup(ctx context.Context) error

func (*Runner) PrepareJobConfigs

func (r *Runner) PrepareJobConfigs(options RunnerOptions) error

func (*Runner) Run

func (r *Runner) Run() error

type RunnerOptions

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

type StatusBoard

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

StatusBoard renders a live, repainting list of job statuses to a terminal. Once Start is called it owns the cursor region it draws, so nothing else should write to the same output until Stop returns.

func NewStatusBoard

func NewStatusBoard(jobNames []string, out io.Writer) *StatusBoard

func (*StatusBoard) Start

func (b *StatusBoard) Start()

Start spawns the renderer goroutine, which repaints on a fixed interval until Stop is called.

func (*StatusBoard) Stop

func (b *StatusBoard) Stop()

Stop ends the renderer and blocks until the final frame is painted.

func (*StatusBoard) Update

func (b *StatusBoard) Update(name string, state JobState)