release

package

v0.0.0-...-7d67436 Latest Latest Go to latest Published: Jun 21, 2020 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/UiP9AV6Y/changelog-assembler

Links

Open Source Insights

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 ¶

View Source

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

View Source

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

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

)

View Source

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL