runkit

Documentation

Index

• func Decorate(ctx context.Context, src, dest string, runxConfig, runxDoc []byte) error
• type Action
  • func (action Action) GetRunnable(ref string) (*Runnable, error)
• type ActionType
• type Config
• type RunKit
  • func Get(ctx context.Context, src string) (*RunKit, error)
  • func (rk *RunKit) GetRunnable(action string) (*Runnable, error)
• type Runnable
  • func GetRunnable(rk *RunKit, action string) (*Runnable, error)
  • func (r Runnable) Run(ctx context.Context) error
  • func (r Runnable) String() string
• type TemplateData

Functions

func Decorate

func Decorate(ctx context.Context, src, dest string, runxConfig, runxDoc []byte) error

Types

type Action

type Action struct {
	ID      string     `yaml:"id" json:"id"`
	Type    ActionType `yaml:"type" json:"type"`
	Command string     `yaml:"cmd" json:"cmd,omitempty"`
	Env     []string   `yaml:"env,omitempty" json:"env,omitempty"`
}

func (Action) GetRunnable

func (action Action) GetRunnable(ref string) (*Runnable, error)

type ActionType

type ActionType string

const (
	ActionTypeRun ActionType = "run"
)

type Config

type Config struct {
	Actions []Action `yaml:"actions" json:"actions"`
}

type RunKit

type RunKit struct {
	Config Config
	Readme string
	// contains filtered or unexported fields
}

func Get

func Get(ctx context.Context, src string) (*RunKit, error)

func (*RunKit) GetRunnable

func (rk *RunKit) GetRunnable(action string) (*Runnable, error)

type Runnable

type Runnable struct {
	Command string
	Args    string
}

func GetRunnable

func GetRunnable(rk *RunKit, action string) (*Runnable, error)

func (Runnable) Run

func (r Runnable) Run(ctx context.Context) error

func (Runnable) String

func (r Runnable) String() string

type TemplateData

type TemplateData struct {
	Ref string
	Env map[string]string
}