release

Documentation

Index

• Constants
• type Category
• type Drafter
• type Replacer
• type SortBy
• type SortDirection
• type Version
• type VersionComponent
• type VersionResolver

Constants

const (
	MergedAtSortBy string = "merged_at"
	TitleSortBy    string = "title"
)

Types

type Category

type Category struct {
	Title  string   `yaml:",omitempty"`
	Labels []string `yaml:",omitempty"`
}

type Drafter

type Drafter struct {
	Template           string          `yaml:",omitempty"`
	NameTemplate       string          `yaml:"name-template,omitempty"`
	TagTemplate        string          `yaml:"tag-template,omitempty"`
	VersionTemplate    string          `yaml:"version-template,omitempty"`
	ChangeTemplate     string          `yaml:"change-template,omitempty"`
	ChangeTitleEscapes string          `yaml:"change-title-escapes,omitempty"`
	NoChangesTemplate  string          `yaml:"no-changes-template,omitempty"`
	References         []string        `yaml:",omitempty"`
	Categories         []Category      `yaml:",omitempty"`
	ExcludeLabels      []string        `yaml:"exclude-labels,omitempty"`
	IncludeLabels      []string        `yaml:"include-labels,omitempty"`
	Replacers          []Replacer      `yaml:",omitempty"`
	SortBy             SortBy          `yaml:"sort-by,omitempty"`
	SortDirection      SortDirection   `yaml:"sort-direction,omitempty"`
	PreRelease         bool            `yaml:",omitempty"`
	VersionResolver    VersionResolver `yaml:"version-resolver,omitempty"`
}

type Replacer

type Replacer struct {
	Search  string `yaml:",omitempty"`
	Replace string `yaml:",omitempty"`
}

type SortBy

type SortBy string

type SortDirection

type SortDirection string

const (
	AscendingSortDirection  SortDirection = "ascending"
	DescendingSortDirection SortDirection = "descending"
)

type Version

type Version struct {
	Labels []string `yaml:",omitempty"`
}

type VersionComponent

type VersionComponent string

const (
	MajorVersionComponent VersionComponent = "major"
	MinorVersionComponent VersionComponent = "minor"
	PatchVersionComponent VersionComponent = "patch"
)

type VersionResolver

type VersionResolver struct {
	Major   Version          `yaml:",omitempty"`
	Minor   Version          `yaml:",omitempty"`
	Patch   Version          `yaml:",omitempty"`
	Default VersionComponent `yaml:",omitempty"`
}