config

Documentation

Overview

Package config provides changelog configuration.

Index

• Constants
• type Config
  • func New(rootDir string) *Config
  • func NewFromFile(rootDir string, cfgFilename string) (*Config, error)

Constants

const (
	// DefaultEntriesDir is the default directory for changelog entries.
	DefaultEntriesDir = ".chloggen"
	// DefaultTemplateYAML is the default template file for changelog entries.
	DefaultTemplateYAML = "TEMPLATE.yaml"
	// DefaultChangeLogKey is the default key for the changelog.
	DefaultChangeLogKey = "default"
	// DefaultChangeLogFilename is the default filename for the changelog.
	DefaultChangeLogFilename = "CHANGELOG.md"
)

Types

type Config

type Config struct {
	ChangeLogs        map[string]string `yaml:"change_logs"`
	DefaultChangeLogs []string          `yaml:"default_change_logs"`
	EntriesDir        string            `yaml:"entries_dir"`
	TemplateYAML      string            `yaml:"template_yaml"`
	SummaryTemplate   string            `yaml:"summary_template"`
	Components        []string          `yaml:"components"`
	ConfigYAML        string
}

Config represents the configuration for changelogs.

func New

func New(rootDir string) *Config

New returns a new Config with default values.

func NewFromFile

func NewFromFile(rootDir string, cfgFilename string) (*Config, error)

NewFromFile returns a new Config from the specified YAML file.