command

Documentation

Index

• func ExpandArg(arg string, env map[string]any) string
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
• type Step
  • func (s Step) Execute(env map[string]any) ([]byte, []byte, error)
  • func (s *Step) ParseArgs(env map[string]any) ([]string, []string)
• type StepList
  • func (l *StepList) Execute(env map[string]any) error

Functions

func ExpandArg

func ExpandArg(arg string, env map[string]any) string

ExpandArgs expands the arguments.

Types

type Error

type Error struct {
	// The error message.
	Message string

	// An optional error that caused this error.
	Err error

	// The step or steplist that caused the error.
	Step     Step
	Steplist *StepList
}

func (*Error) Error

func (e *Error) Error() string

Error returns the error message.

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap returns the underlying error.

type Step

type Step struct {
	Name    string   `yaml:"name"`    // The name of the step.
	Command string   `yaml:"command"` // The command to run.
	Args    []string `yaml:"args"`    // The arguments to pass to the command.
}

CommandStep represents a command to run.

func (Step) Execute

func (s Step) Execute(env map[string]any) ([]byte, []byte, error)

Execute runs the command.

func (*Step) ParseArgs

func (s *Step) ParseArgs(env map[string]any) ([]string, []string)

ParseArgs parses the arguments.

type StepList

type StepList struct {
	Steps []Step `yaml:"steps"`
}

func (*StepList) Execute

func (l *StepList) Execute(env map[string]any) error