config

Documentation

Overview

Package config contains tunk's configuration, as well as an abstraction for handling standard io.

Index

• Variables
• type Config
  • func GetDefault() Config
  • func New(overrides *Config) Config
  • func NewWithTerminalIO(overrides *Config, termio *TerminalIO) Config
  • func (c Config) Debugf(msg string, args ...interface{})
  • func (c Config) Errorf(msg string, args ...interface{})
  • func (c Config) GetBranches() []string
  • func (c Config) GetPolicies() []*Policy
  • func (c Config) GetPolicy(name string) *Policy
  • func (c Config) OverridesSet() bool
  • func (c Config) Printf(msg string, args ...interface{})
  • func (c Config) Validate() error
  • func (c Config) Warning(msg string, args ...interface{})
• type Policy
  • func (p *Policy) GetBodyAnnotationRE() *regexp.Regexp
  • func (p *Policy) GetSubjectRE() *regexp.Regexp
  • func (p *Policy) TextSummary(w io.Writer) error
• type TerminalIO
  • func (t *TerminalIO) Printf(msg string, args ...interface{})

Variables

var DefaultTermIO = TerminalIO{
	Stdin:  os.Stdin,
	Stdout: os.Stdout,
	Stderr: os.Stderr,
}

Types

type Config

type Config struct {
	InCI           bool       `json:"ci,omitempty"`
	Debug          bool       `json:"debug,omitempty"`
	Dryrun         bool       `json:"dryrun,omitempty"`
	Quiet          bool       `json:"quiet,omitempty"`
	All            bool       `json:"all,omitempty"`
	Scope          string     `json:"scope,omitempty"`
	Name           string     `json:"name,omitempty"`
	Major          bool       `json:"major,omitempty"`
	Minor          bool       `json:"minor,omitempty"`
	Patch          bool       `json:"patch,omitempty"`
	Branches       []string   `json:"branches,omitempty"`
	ReleaseScopes  []string   `json:"release_scopes,omitempty"`
	Policies       []string   `json:"policies,omitempty"`
	CustomPolicies []Policy   `json:"custom_policies,omitempty"`
	TagTemplate    string     `json:"tag_template,omitempty"`
	LogTemplate    string     `json:"log_template,omitempty"`
	NoEdit         bool       `json:"no_edit,omitempty"`
	AllowedScopes  []string   `json:"allowed_scopes,omitempty"`
	AllowedTypes   []string   `json:"allowed_types,omitempty"`
	Term           TerminalIO `json:"-"`

	// IgnorePolicies ignores policy restrictions. Intended for testing only.
	IgnorePolicies bool `json:"-"`
	BranchesSet    bool `json:"-"`
}

func GetDefault

func GetDefault() Config

func New

func New(overrides *Config) Config

func NewWithTerminalIO

func NewWithTerminalIO(overrides *Config, termio *TerminalIO) Config

func (Config) Debugf

func (c Config) Debugf(msg string, args ...interface{})

func (Config) Errorf

func (c Config) Errorf(msg string, args ...interface{})

func (Config) GetBranches

func (c Config) GetBranches() []string

func (Config) GetPolicies

func (c Config) GetPolicies() []*Policy

func (Config) GetPolicy

func (c Config) GetPolicy(name string) *Policy

func (Config) OverridesSet

func (c Config) OverridesSet() bool

func (Config) Printf

func (c Config) Printf(msg string, args ...interface{})

func (Config) Validate

func (c Config) Validate() error

func (Config) Warning

func (c Config) Warning(msg string, args ...interface{})

type Policy

type Policy struct {
	Name                  string            `json:"name"`
	SubjectRE             string            `json:"subject_regex"`
	BodyAnnotationStartRE string            `json:"body_annotation_start_regex"`
	BreakingChangeTypes   []string          `json:"breaking_change_annotations"`
	CommitTypes           map[string]string `json:"commit_types"`
	FallbackReleaseType   string            `json:"fallback_type,omitempty"`
	// contains filtered or unexported fields
}

func (*Policy) GetBodyAnnotationRE

func (p *Policy) GetBodyAnnotationRE() *regexp.Regexp

func (*Policy) GetSubjectRE

func (p *Policy) GetSubjectRE() *regexp.Regexp

func (*Policy) TextSummary

func (p *Policy) TextSummary(w io.Writer) error

type TerminalIO

type TerminalIO struct {
	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer
}

func (*TerminalIO) Printf

func (t *TerminalIO) Printf(msg string, args ...interface{})