model

Documentation

Index

• type Changelog
  • func NewChangelog() *Changelog
• type Entry
• type Subsection
• type Version

Types

type Changelog

type Changelog struct {
	Header   []string
	Versions []*Version
}

Changelog represents a changelog in its entirety, containing all the versions that are tracked in the changelog. For supported formats, see the documentation for Version.

func NewChangelog

func NewChangelog() *Changelog

NewChangelog creates a pristine Changelog.

type Entry

type Entry struct {
	// What the change entails.
	Summary  string
	Position int // Line number in the changelog
}

Entry contains the data for a single change.

type Subsection

type Subsection struct {
	Name       string
	History    []*Entry
	SourceLine string
	Position   int // Line number in the changelog
}

Subsection contains the data for a given subsection.

type Version

type Version struct {
	Version     string
	Subsections []*Subsection
	SourceLine  string
	Position    int // Line number in the changelog
}

Version contains the data for the changes for a given version. It can have both direct history and subsections.