settings

Documentation

Index

• Variables
• type Context
• type Contexts
• type Defaults
• type Service
• type Services
• type Settings
  • func FromBytes(data []byte) (*Settings, error)
  • func Read(location string, client gh.Client) (*Settings, error)
  • func ReadFromFile(filename string) (*Settings, error)
  • func ReadFromGitHub(filename string, client gh.Client) (*Settings, error)
  • func (s *Settings) Clean(contextName string)
  • func (s *Settings) Service(name string) *Service

Variables

var (
	DefaultLocation = gh.Location{
		Ref: "master",
	}
	DefaultContext = "default"
)

Types

type Context

type Context struct {
	Variables templates.Variables `yaml:"variables"`
}

type Contexts

type Contexts map[string]Context

type Defaults

type Defaults struct {
	Location  gh.Location         `yaml:",inline"`
	Variables templates.Variables `yaml:"variables"`
	Context   string              `yaml:"context"`
}

type Service

type Service struct {
	Name      string              `yaml:"name,omitempty"`
	Location  gh.Location         `yaml:",inline"`
	Variables templates.Variables `yaml:"variables"`
}

type Services

type Services []Service

type Settings

type Settings struct {
	Defaults Defaults `yaml:"defaults"`
	Services Services `yaml:"services"`
	Contexts Contexts `yaml:"contexts"`
}

func FromBytes

func FromBytes(data []byte) (*Settings, error)

func Read

func Read(location string, client gh.Client) (*Settings, error)

func ReadFromFile

func ReadFromFile(filename string) (*Settings, error)

func ReadFromGitHub

func ReadFromGitHub(filename string, client gh.Client) (*Settings, error)

func (*Settings) Clean

func (s *Settings) Clean(contextName string)

func (*Settings) Service

func (s *Settings) Service(name string) *Service