stacks

Documentation

Overview

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

SPDX-License-Identifier: MIT Copyright (c) 2019 Hadrien Chauvin

Index

• func Exec(ctx context.Context, cfg *config.Config, pipeline *pipelines.Pipeline, ...) (err error)
• func Hold(cfg *config.Config, pipeline *pipelines.Pipeline) (*names.Name, name_manager.ReleaseFunc, error)
• func List(ctx context.Context, cfg *config.Config, pipeline *pipelines.Pipeline, ...) ([]string, error)
• func Remove(ctx context.Context, cfg *config.Config, pipeline *pipelines.Pipeline, ...) 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, name_manager.ReleaseFunc, error)

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.

func Remove

func Remove(ctx context.Context, cfg *config.Config, pipeline *pipelines.Pipeline, shortName string) error

Remove removes the stack with the given short name. The short name (combined with the family name to give the full name) is optional if the stack does not come with a family name but instead with one single name.

Types

type ExecConfig

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

ExecConfig is the configuration for the Exec function.