config

Documentation

Index

• Constants
• Variables
• type Action
• type Config
  • func Get(path string) (config Config, err error)
  • func (self Config) GetRunnableTasks(slugs []string) []Task
• type Mail
• type Notify
• type Ping
  • func (self Ping) GetEndpoint() (string, error)
• type Storage
• type Task
  • func (self Task) GetBuiltInAction() Action
  • func (self Task) GetDisplayEnabled() string
  • func (self Task) GetLongString() string
  • func (self Task) GetShortString() string
• type User

Constants

const (
	TaskTypeExec    = "exec"
	TaskTypeBuiltIn = "builtin"
)

Variables

var ValidTaskTypes = []string{
	TaskTypeExec,
	TaskTypeBuiltIn,
}

Types

type Action

type Action func(args *args.Args, logger *logger.Logger) error

type Config

type Config struct {
	Tasks   []Task             `json:"tasks"`
	User    User               `json:"user"`
	PassBin string             `json:"passBin"`
	Storage map[string]Storage `json:"storage"`
	Ping    Ping               `json:"ping"`
	Notify  Notify             `json:"notify"`
	Mail    Mail               `json:"mail"`
	Filters []string           `json:"filters"`
}

func Get

func Get(path string) (config Config, err error)

func (Config) GetRunnableTasks

func (self Config) GetRunnableTasks(slugs []string) []Task

type Mail

type Mail struct {
	Enabled bool   `json:"enabled"`
	Type    string `json:"type"`
}

type Notify

type Notify struct {
	Enabled bool `json:"enabled"`
}

type Ping

type Ping struct {
	Enabled  bool   `json:"enabled"`
	Endpoint string `json:"endpoint"`
}

func (Ping) GetEndpoint

func (self Ping) GetEndpoint() (string, error)

type Storage

type Storage struct {
	Path   string `json:"path"`
	Commit bool   `json:"commit"`
	Chown  bool   `json:"chown"`
}

type Task

type Task struct {
	Slug       string `json:"slug"`
	Name       string `json:"name"`
	Type       string `json:"type"`
	Scheduled  bool   `json:"scheduled"`
	Post       bool   `json:"post"`
	EntryPoint string `json:"entrypoint"`
}

func (Task) GetBuiltInAction

func (self Task) GetBuiltInAction() Action

func (Task) GetDisplayEnabled

func (self Task) GetDisplayEnabled() string

func (Task) GetLongString

func (self Task) GetLongString() string

func (Task) GetShortString

func (self Task) GetShortString() string

type User

type User struct {
	Name  string `json:"name"`
	Email string `json:"email"`
}