executer

Documentation

Index

• func Run(ctx context.Context, ui *ui.UI, c *config.ShuttleProjectContext, path string, ...) error
• type Action
• type ActionArg
• type Actions
  • func List(ctx context.Context, ui *ui.UI, path string, c *config.ShuttleProjectContext) (*Actions, error)
  • func NewActions() *Actions
  • func (a *Actions) Execute(action string, fn func() error) (ran bool, err error)
  • func (a *Actions) Merge(other ...*Actions) *Actions

Functions

func Run

func Run(
	ctx context.Context,
	ui *ui.UI,
	c *config.ShuttleProjectContext,
	path string,
	args ...string,
) error

Types

type Action

type Action struct {
	Args []ActionArg `json:"args"`
}

type ActionArg

type ActionArg struct {
	Name string `json:"name"`
}

type Actions

type Actions struct {
	Actions map[string]Action `json:"actions"`
}

Actions represents all the possible commands to be sent to the golang actions binaries. Such as `shuttle run daggerbuild --arg something`, in this daggerbuild would be the name, and arg being an Arg for said action

func List

func List(
	ctx context.Context,
	ui *ui.UI,
	path string,
	c *config.ShuttleProjectContext,
) (*Actions, error)

func NewActions

func NewActions() *Actions

func (*Actions) Execute

func (a *Actions) Execute(action string, fn func() error) (ran bool, err error)

Execute can execute a single action given a name, and a closure to handle any actual execution

func (*Actions) Merge

func (a *Actions) Merge(other ...*Actions) *Actions

Merge exists to combine multiple Actions from a variety of binaries into one. This allows a single set of actions to represent all possible actions by shuttle in a given context