config

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 28, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package config contains the definition of the configuration file.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	// categories to parse in pull requests
	Categories []struct {
		Title  string   `yaml:"title"`
		Labels []string `yaml:"labels"`

		// regexp to match branch name
		Branch string `yaml:"branch"`
	} `yaml:"categories"`
	// labels for pull requests, which won't be in release notes
	IgnoreLabels []string `yaml:"ignore_labels"`
	// field, by which pull requests must be sorted, in format +|-field
	// currently supported fields: number, author, title, closed
	SortField string `yaml:"sort_field"`
	// template for a changelog.
	Template string `yaml:"template"`
	// if set, the unused category will be built under this title at the
	// end of the changelog
	UnusedTitle string `yaml:"unused_title"`
}

Config defines configuration for the release notes builder.

func Read

func Read(path string) (Config, error)

Read parses and validates the configuration

func (Config) Validate

func (c Config) Validate() error

Validate validates the configuration.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL