changelog

Documentation

Index

• Constants
• type Changelog
  • func New(opts *Options) *Changelog
  • func (c *Changelog) Run() error
  • func (c *Changelog) SetImpl(impl impl)
• type Options

Constants

const (
	// The default CHANGELOG directory inside the k/k repository.
	RepoChangelogDir = "CHANGELOG"

	TocEnd = "<!-- END MUNGE: GENERATED_TOC -->"
)

Types

type Changelog

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

Changelog can be used to generate the changelog for a release.

func New

func New(opts *Options) *Changelog

New creates a new Changelog instance.

func (*Changelog) Run

func (c *Changelog) Run() error

Run starts the changelog generation.

func (*Changelog) SetImpl

func (c *Changelog) SetImpl(impl impl)

SetImpl can be used to set the internal implementation.

type Options

type Options struct {
	RepoPath     string
	Tag          string
	Branch       string
	Bucket       string
	Tars         string
	HTMLFile     string
	JSONFile     string
	RecordDir    string
	ReplayDir    string
	Dependencies bool
}

Options are the main settings for generating the changelog.