changelog

Documentation

Index

• Variables
• func WriteChangelog(org, repo string, previousVersion, version *semver.Version, ...) (Markdown, Markdown, error)
• func WriteToFile(path string, lines Markdown) error
• type Markdown
  • func GenerateNewChangelog(org, repo string, previousVersion, version *semver.Version, ...) (body Markdown)
  • func (b Markdown) String() (s string)
• type Section

Variables

var Path = "CHANGELOG.md"

var UpdateChangelog = updateChangelog

var WriteString = writeString

Functions

func WriteChangelog

func WriteChangelog(org, repo string, previousVersion, version *semver.Version, commits conventional.Commits, disableVersionHeader bool) (Markdown, Markdown, error)

func WriteToFile

func WriteToFile(path string, lines Markdown) error

Types

type Markdown

type Markdown []string

func GenerateNewChangelog

func GenerateNewChangelog(org, repo string, previousVersion, version *semver.Version, commits conventional.Commits, disableVersionHeader bool) (body Markdown)

GenerateNewChangelog generates a Markdown formatted changelog from the provided GitHub commits. It is intended to aggregate the changes from just the commits since the previous version.

func (Markdown) String

func (b Markdown) String() (s string)

type Section

type Section struct {
	Title   string
	Commits []*github.RepositoryCommit
}