changelogger

Documentation

Index

• type Change
  • func (c Change) TitleOrRef() string
  • func (c Change) Validate(fileName string) error
• type Changes
  • func (cs Changes) ByCategory(cat string) Changes
  • func (cs Changes) Len() int
  • func (cs Changes) Less(i, j int) bool
  • func (cs Changes) Swap(i, j int)

Types

type Change

type Change struct {
	// Required change category or change type, for a list of all supported
	// change types see matcher.go.
	Category string

	// Required title, if set, it will use the title.
	Title string

	// Optional change description.
	Description string

	// Optional reference for the change source. If not set, it will use the
	// name of the note. It'll be formatted with the base-url
	Ref string
}

func (Change) TitleOrRef

func (c Change) TitleOrRef() string

func (Change) Validate

func (c Change) Validate(fileName string) error

Validate validates that the change entry is usable.

type Changes

type Changes []Change

func (Changes) ByCategory

func (cs Changes) ByCategory(cat string) Changes

func (Changes) Len

func (cs Changes) Len() int

func (Changes) Less

func (cs Changes) Less(i, j int) bool

func (Changes) Swap

func (cs Changes) Swap(i, j int)