changelog_generator

README

📝 changelog-generator-default

The default changelog generator for go-semantic-release.

Output of the changelog

The changelog generator will order the types of commits in the changelog in the following order:

• Breaking Changes
• Feature
• Bug Fixes
• Reverts
• Performance Improvements
• Documentation
• Tests
• Code Refactoring
• Styles
• Chores
• Build
• CI

Emoji changelogs

In order to use emoji changelogs including a prefixed emoji, you need to provide the following config when calling semantic-relase: --changelog-generator-opt "emojis=true". Or add the config within your .semrelrc file.

Example Change Log

Licence

The MIT License (MIT)

Copyright © 2020 Christoph Witzko

Documentation

Index

• Variables
• type ChangelogType
• type ChangelogTypes
  • func NewChangelogTypes() ChangelogTypes
  • func (ct *ChangelogTypes) AppendContent(cType, content string)
• type DefaultChangelogGenerator
  • func (g *DefaultChangelogGenerator) Generate(commits []*semrel.Commit, latestRelease *semrel.Release, newVersion string) string
  • func (g *DefaultChangelogGenerator) Init(m map[string]string) error
  • func (g *DefaultChangelogGenerator) Name() string
  • func (g *DefaultChangelogGenerator) Version() string

Variables

var CGVERSION = "dev"

Types

type ChangelogType

type ChangelogType struct {
	Type    string
	Text    string
	Content string
	Emoji   string
}

type ChangelogTypes

type ChangelogTypes []ChangelogType

func NewChangelogTypes

func NewChangelogTypes() ChangelogTypes

func (*ChangelogTypes) AppendContent

func (ct *ChangelogTypes) AppendContent(cType, content string)

type DefaultChangelogGenerator

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

func (*DefaultChangelogGenerator) Generate

func (g *DefaultChangelogGenerator) Generate(commits []*semrel.Commit, latestRelease *semrel.Release, newVersion string) string

func (*DefaultChangelogGenerator) Init

func (g *DefaultChangelogGenerator) Init(m map[string]string) error

func (*DefaultChangelogGenerator) Name

func (g *DefaultChangelogGenerator) Name() string

func (*DefaultChangelogGenerator) Version

func (g *DefaultChangelogGenerator) Version() string