changelog

Documentation

Index

• type Change
• type Changes
  • func (c Changes) Sorted() error
• type Entry
  • func ReadEntry(r io.Reader, version string) (*Entry, error)
  • func (c Entry) Name() string
• type Kind
  • func (k Kind) String() string
• type Kinds
  • func ParseKinds(s string) Kinds
  • func (k Kinds) Len() int
  • func (k Kinds) Less(i, j int) bool
  • func (k Kinds) String() string
  • func (k Kinds) Swap(i, j int)

Types

type Change

type Change struct {
	Text  string
	Kinds Kinds
}

Change represents a change description.

type Changes

type Changes []Change

func (Changes) Sorted

func (c Changes) Sorted() error

type Entry

type Entry struct {
	Version string
	Date    time.Time
	Changes Changes
	Text    string
}

Entry represents an entry in the changelog.

func ReadEntry

func ReadEntry(r io.Reader, version string) (*Entry, error)

ReadEntry reads the entry for the given version from the changelog file. It returns an error if the version is not found.

func (Entry) Name

func (c Entry) Name() string

Name returns the canonical name of the entry.

type Kind

type Kind int

Kind represents the type of a change.

func (Kind) String

func (k Kind) String() string

type Kinds

type Kinds []Kind

Kinds is a list of Kind which implements sort.Interface.

func ParseKinds

func ParseKinds(s string) Kinds

ParseKinds converts a slash-separated list of Kind to a list of Kind.

func (Kinds) Len

func (k Kinds) Len() int

func (Kinds) Less

func (k Kinds) Less(i, j int) bool

func (Kinds) String

func (k Kinds) String() string

func (Kinds) Swap

func (k Kinds) Swap(i, j int)