edward

Documentation

Index

• type Client
  • func NewClient() (*Client, error)
  • func NewClientWithConfig(configPath, version string) (*Client, error)
  • func (c *Client) BasePath() string
  • func (c *Client) Generate(names []string, force bool, group string, targets []string) error
  • func (c *Client) List() error
  • func (c *Client) LoadConfig(edwardVersion string) error
  • func (c *Client) Log(names []string, cancelChannel <-chan struct{}) error
  • func (c *Client) Restart(names []string, force bool, skipBuild bool, noWatch bool, exclude []string) error
  • func (c *Client) ServiceMap() map[string]*services.ServiceConfig
  • func (c *Client) Start(names []string, skipBuild bool, noWatch bool, exclude []string) error
  • func (c *Client) Status(names []string, all bool) error
  • func (c *Client) Stop(names []string, force bool, exclude []string, all bool) error
  • func (c *Client) TipLog(names []string, lineCount int) error
  • func (c *Client) Version() string
• type TaskFollower

Types

type Client

type Client struct {
	UI ui.Provider

	Config string

	ServiceChecks func([]services.ServiceOrGroup) error

	EdwardExecutable string

	LogFile string // Path to log file

	Follower TaskFollower

	// Prevent build, launch and stop phases from running concurrently
	DisableConcurrentPhases bool

	WorkingDir string

	Tags []string // Tags to distinguish runners started by this instance of edward

	DirConfig *home.EdwardConfiguration

	Backends map[string]string // Service overrides for backends
	// contains filtered or unexported fields
}

func NewClient

func NewClient() (*Client, error)

NewClient creates an edward client an empty configuration

func NewClientWithConfig

func NewClientWithConfig(configPath, version string) (*Client, error)

NewClientWithConfig creates an Edward client and loads the config from the given path

func (*Client) BasePath

func (c *Client) BasePath() string

func (*Client) Generate

func (c *Client) Generate(names []string, force bool, group string, targets []string) error

func (*Client) List

func (c *Client) List() error

func (*Client) LoadConfig

func (c *Client) LoadConfig(edwardVersion string) error

LoadConfig loads an Edward project config into the shared maps for this client

func (*Client) Log

func (c *Client) Log(names []string, cancelChannel <-chan struct{}) error

func (*Client) Restart

func (c *Client) Restart(names []string, force bool, skipBuild bool, noWatch bool, exclude []string) error

func (*Client) ServiceMap

func (c *Client) ServiceMap() map[string]*services.ServiceConfig

func (*Client) Start

func (c *Client) Start(names []string, skipBuild bool, noWatch bool, exclude []string) error

func (*Client) Status

func (c *Client) Status(names []string, all bool) error

func (*Client) Stop

func (c *Client) Stop(names []string, force bool, exclude []string, all bool) error

func (*Client) TipLog

func (c *Client) TipLog(names []string, lineCount int) error

TipLog outputs the last few log lines for each service

func (*Client) Version

func (c *Client) Version() string

type TaskFollower

type TaskFollower interface {
	Handle(update tracker.Task)
	Done()
}