stacks

Documentation

Overview

Package stacks implements the acquisition and release of stacks, using name_manager.

Index

• func Exec(ctx context.Context, cfg *config.Config, pipeline *pipelines.Pipeline, ...) (err error)
• func Hold(cfg *config.Config, pipeline *pipelines.Pipeline) (*names.Name, <-chan error, name_manager.ReleaseFunc, error)
• func List(ctx context.Context, cfg *config.Config, pipeline *pipelines.Pipeline, ...) ([]string, error)
• type ExecConfig

Functions

func Exec

func Exec(
	ctx context.Context,
	cfg *config.Config,
	pipeline *pipelines.Pipeline,
	execCfg *ExecConfig,
	detachedErrc chan<- error,
) (err error)

Exec executes the stages in a pipeline. Detached errors (of goroutines that execute in the background) are reported in a channel.

func Hold

func Hold(cfg *config.Config, pipeline *pipelines.Pipeline) (*names.Name, <-chan error, name_manager.ReleaseFunc, error)

Hold uses name_manager to hold a stack for the given pipeline.

func List

func List(
	ctx context.Context,
	cfg *config.Config,
	pipeline *pipelines.Pipeline,
	freeOnly bool,
) ([]string, error)

List lists all the stack names for a pipeline. If freeOnly is true, only the stacks that are not currently in use are returned. Otherwise, all the stack anems are returned.

Types

type ExecConfig

type ExecConfig struct {
	Name             names.Name
	Dev              bool
	Tail             bool
	Run              []string
	Setup            string
	DumpEnv          string
	PersistEnv       bool
	WaitForInterrupt bool
}

ExecConfig is the configuration for the Exec function.