config

Documentation

Index

• Variables
• type Config
  • func New(configPath string) (*Config, error)
  • func (c Config) NameLabels() []NameLabel
• type Group
  • func (g Group) NameLabels() []NameLabel
• type NameLabel

Variables

var DefaultConfig []byte

Types

type Config

type Config struct {
	Repo       string         `yaml:"repo"`
	Service    string         `yaml:"service"`
	BaseURL    string         `yaml:"base-url"`
	Groups     []Group        `yaml:"groups"`
	SkipLabels string         `yaml:"skip-labels"`
	SkipRegex  *regexp.Regexp `yaml:"-"`
}

Config is the changelog settings

func New

func New(configPath string) (*Config, error)

New Load a config from a path, defaulting to changelog.example.yml

func (Config) NameLabels

func (c Config) NameLabels() []NameLabel

NameLabels returns a slice of NameLabel for each Group, keeping them in order (priority)

type Group

type Group struct {
	Name    string   `yaml:"name"`
	Labels  []string `yaml:"labels"`
	Default bool     `yaml:"default"`
}

Group is a grouping of PRs

func (Group) NameLabels

func (g Group) NameLabels() []NameLabel

NameLabels returns a slice of NameLabel

type NameLabel

type NameLabel struct {
	Name  string
	Label string
}

NameLabel is a Group mapping for a Label to a Name