changelog

Documentation

Index

• Variables
• type Args
• type Generator
  • func New(args ...func(arg *Args)) *Generator
  • func (g Generator) Add(nextV version.V) (err error)
  • func (g Generator) Generate() (err error)

Variables

var (
	// ErrWarning is a warning error.
	ErrWarning = fmt.Errorf("changelog warning")
)

Types

type Args

type Args struct {
	Repo        gitRepo
	RW          readWriter
	Backup      backupSrv
	ConfigFile  fsys.File
	CommitNames []config.CommitName
}

Args is a Generator arguments.

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator generates changelog.

func New

func New(args ...func(arg *Args)) *Generator

New creates new Generator.

func (Generator) Add

func (g Generator) Add(nextV version.V) (err error)

Add adds new version to changelog.

func (Generator) Generate

func (g Generator) Generate() (err error)

Generate generates changelog.