actions

package
v0.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 14, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Start

func Start(ctx context.Context, plan Plan) <-chan Event

Start runs every step in a plan and emits output/final status events.

Types

type Command

type Command struct {
	Program string
	Args    []string
}

Command is an executable program plus arguments.

type Event

type Event struct {
	Step int
	Line string
	Done bool
	Err  error
}

Event reports output or completion from a running action plan.

type Plan

type Plan struct {
	Title           string
	Steps           []Step
	RequiresConfirm bool
	ConfirmText     string
}

Plan describes a dependency-aware action and the commands needed to run it.

func PlanExecCommand

func PlanExecCommand(containerID, command string) Plan

PlanExecCommand builds a one-shot in-TUI docker exec command.

func PlanExecShell

func PlanExecShell(containerID string) Plan

PlanExecShell builds a plan to open a shell in a running container.

func PlanRebuildAndRestartDependents

func PlanRebuildAndRestartDependents(project Project, graph *dag.Graph, service string) Plan

PlanRebuildAndRestartDependents rebuilds a service then restarts dependents.

func PlanRebuildSelected

func PlanRebuildSelected(project Project, service string) Plan

PlanRebuildSelected builds a plan to rebuild one service without dependencies.

func PlanRestartDependents

func PlanRestartDependents(project Project, graph *dag.Graph, service string) Plan

PlanRestartDependents builds a plan to restart downstream dependents.

func PlanRestartSelected

func PlanRestartSelected(project Project, service string) Plan

PlanRestartSelected builds a plan to restart one Compose service.

func PlanStartSelected added in v0.4.0

func PlanStartSelected(project Project, service string) Plan

PlanStartSelected builds a plan to start one previously-stopped Compose service.

func PlanStopSelected added in v0.4.0

func PlanStopSelected(project Project, service string) Plan

PlanStopSelected builds a plan to stop one Compose service.

type Project

type Project struct {
	Name        string
	ConfigFiles []string
}

Project contains Compose metadata needed to run project-scoped commands.

type Step

type Step struct {
	Service string
	Label   string
	Command Command
}

Step is one command in an action plan.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL