release

Documentation

Index

• Constants
• type Changelog
  • func NewChangelog(input io.EntityReader, output *Renderer) *Changelog
  • func (w *Changelog) Write(version string) (err error)
• type Parser
  • func NewParser(ios io.IOFactory) *Parser
  • func (p *Parser) Read(version string) (err error)
• type RenderContext
  • func NewRenderContext(version string, entries change.Entries) *RenderContext
  • func (c *RenderContext) Date() string
• type Renderer
  • func NewRenderer(writers io.IOFactory) *Renderer
  • func (r *Renderer) Write(data *RenderContext) (err error)

Constants

const (
	DefaultOutputFile      = "CHANGELOG.md"
	StartDelimiterTemplate = `<a name="%s"></a>`
	EndDelimiterTemplate   = `<!-- changelog-assembler: %s -->`
)

const (
	DefaultTemplate = `` /* 221-byte string literal not displayed */

	GroupedTemplate = `` /* 479-byte string literal not displayed */

)

const (
	VersionDateFormat = "2006-01-02"
)

Types

type Changelog

type Changelog struct {
	UnreleasedDir string
	RetainInput   bool
	// contains filtered or unexported fields
}

func NewChangelog

func NewChangelog(input io.EntityReader, output *Renderer) *Changelog

func (*Changelog) Write

func (w *Changelog) Write(version string) (err error)

type Parser

type Parser struct {
	InputFile  string
	OutputFile string
	// contains filtered or unexported fields
}

func NewParser

func NewParser(ios io.IOFactory) *Parser

func (*Parser) Read

func (p *Parser) Read(version string) (err error)

type RenderContext

type RenderContext struct {
	Version string
	Notes   string
	Entries change.Entries
	// contains filtered or unexported fields
}

func NewRenderContext

func NewRenderContext(version string, entries change.Entries) *RenderContext

func (*RenderContext) Date

func (c *RenderContext) Date() string

type Renderer

type Renderer struct {
	OutputFile      string
	TemplateFile    string
	GroupComponents bool
	// contains filtered or unexported fields
}

func NewRenderer

func NewRenderer(writers io.IOFactory) *Renderer

func (*Renderer) Write

func (r *Renderer) Write(data *RenderContext) (err error)