config

Documentation

Overview

Package config provides access to the comply.yml file.

Index

• Constants
• Variables
• func Exists() bool
• func ProjectRoot() string
• func SetPandoc(pandoc bool, docker bool)
• func SetProjectRoot(dir string)
• func WhichPandoc() string
• func YAML() map[interface{}]interface{}
• type Project
  • func (p *Project) TicketSystem() (string, error)

Constants

const (
	Jira      = "jira"
	GitHub    = "github"
	GitLab    = "gitlab"
	NoTickets = "none"
)

const (
	// UseDocker invokes pandoc within Docker
	UseDocker = "docker"
	// UsePandoc invokes pandoc directly
	UsePandoc = "pandoc"
)

Variables

var Config = func() *Project {
	p := Project{}
	cfgBytes, err := ioutil.ReadFile(filepath.Join(ProjectRoot(), "comply.yml"))
	if err != nil {
		panic("unable to load config.yml: " + err.Error())
	}
	yaml.Unmarshal(cfgBytes, &p)
	return &p
}

Config is the parsed contents of ProjectRoot()/config.yml.

Functions

func Exists

func Exists() bool

Exists tests for the presence of a comply configuration file.

func ProjectRoot

func ProjectRoot() string

ProjectRoot is the fully-qualified path to the root directory.

func SetPandoc

func SetPandoc(pandoc bool, docker bool)

SetPandoc records pandoc availability during initialization

func SetProjectRoot

func SetProjectRoot(dir string)

SetProjectRoot is used by the test suite.

func WhichPandoc

func WhichPandoc() string

WhichPandoc indicates which pandoc invocation path should be used

func YAML

func YAML() map[interface{}]interface{}

YAML is the parsed contents of ProjectRoot()/config.yml.

Types

type Project

type Project struct {
	Name           string                 `yaml:"name"`
	Pandoc         string                 `yaml:"pandoc,omitempty"`
	FilePrefix     string                 `yaml:"filePrefix"`
	Tickets        map[string]interface{} `yaml:"tickets"`
	ApprovedBranch string                 `yaml:"approvedBranch"`
}

func (*Project) TicketSystem

func (p *Project) TicketSystem() (string, error)

TicketSystem indicates the type of the configured ticket system