renderer

Documentation

Index

• type Renderer
  • func New(c *changelog.Changelog) Renderer
  • func (r Renderer) Render(w io.Writer) error
• type Stringer

Types

type Renderer

type Renderer struct {
	// If non-nil, the output will include a level 2 header with the version to which this changelog corresponds.
	Next *semver.Version
	// If non-nil and Next is non-nil, the level 2 header including the version will also include the date returned by
	// this function, signifying that the version to which this changelog corresponds was released on said date.
	ReleasedOn func() time.Time
	// contains filtered or unexported fields
}

Renderer outputs a human-readable, markdown version of a changelog.

func New

func New(c *changelog.Changelog) Renderer

func (Renderer) Render

func (r Renderer) Render(w io.Writer) error

Render writes the markdown representation of a changelog to the specified writer.

type Stringer

type Stringer interface {
	String() string
}

Stringer is anything that can be printed as a list entry on the changelog. changelog.Dependency and changelog.Entry implement this interface.