runkit

Documentation

Index

• Constants
• 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 ConfigAction
• type ConfigImage
• type LocalConfig
  • func GetLocalConfig() LocalConfig
• type Opt
• type RunKit
  • func Get(ctx context.Context, src string) (*RunKit, error)
  • func (rk *RunKit) GetRunnable(action string) (*Runnable, error)
• type Runnable
  • func (r *Runnable) Run(ctx context.Context) error
  • func (r *Runnable) SetOptionValues(opts map[string]string) error
• type TemplateData

Constants

const (
	DefaultLocalConfigFile = ".docker/runx.yaml"
)

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"`
	Desc    string     `yaml:"desc,omitempty" json:"desc,omitempty"`
	Type    ActionType `yaml:"type" json:"type"`
	Command string     `yaml:"cmd" json:"cmd,omitempty"`
	Env     []string   `yaml:"env,omitempty" json:"env,omitempty"`
	Options []Opt      `yaml:"opts,omitempty" json:"opts,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 {
	Default string   `yaml:"default,omitempty" json:"default,omitempty"`
	Actions []Action `yaml:"actions" json:"actions"`
}

type ConfigAction

type ConfigAction struct {
	Opts map[string]string `yaml:"opts,omitempty" json:"opts,omitempty"`
}

type ConfigImage

type ConfigImage struct {
	Default string                  `yaml:"default,omitempty" json:"default,omitempty"`
	Actions map[string]ConfigAction `yaml:"actions,omitempty" json:"actions,omitempty"`
}

type LocalConfig

type LocalConfig struct {
	Ref    string                 `yaml:"ref,omitempty" json:"ref,omitempty"`
	Images map[string]ConfigImage `yaml:"images,omitempty" json:"images,omitempty"`
}

func GetLocalConfig

func GetLocalConfig() LocalConfig

type Opt

type Opt struct {
	Name        string   `yaml:"name" json:"name"`
	Description string   `yaml:"desc" json:"desc,omitempty"`
	Prompt      string   `yaml:"prompt,omitempty" json:"prompt,omitempty"`
	Required    bool     `yaml:"required,omitempty" json:"required,omitempty"`
	Values      []string `yaml:"values,omitempty" json:"values,omitempty"`
}

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

	Action Action
	// contains filtered or unexported fields
}

func (*Runnable) Run

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

func (*Runnable) SetOptionValues

func (r *Runnable) SetOptionValues(opts map[string]string) error

type TemplateData

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