Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Formats = []ChangelogFormat{FormatMarkdown, FormatBBCode}
Functions ¶
This section is empty.
Types ¶
type Changelog ¶
type Changelog struct {
// Internal for data grouping
SemverGroups map[changelog_types.ChangelogSectionType]*changelogSemverGroup
// For template
Header templates.Header
OrderedSemverGroups []*changelogSemverGroup
}
func NewChangelog ¶
func NewChangelog( g *semanticgit.SemanticGit, semver_options semvertype.OptionsSemVer, config settings.ConfigScheme, FromTag types.TagName, ) Changelog
type ChangelogBBCode ¶
type ChangelogBBCode struct {
Changelog
}
func (ChangelogBBCode) GetSemverGroups ¶
func (changelog ChangelogBBCode) GetSemverGroups() map[changelog_types.ChangelogSectionType]*changelogSemverGroup
func (ChangelogBBCode) Render ¶
func (changelog ChangelogBBCode) Render() string
func (ChangelogBBCode) RenderHeader ¶
func (changelog ChangelogBBCode) RenderHeader() string
type ChangelogFormat ¶
type ChangelogFormat string
const ( FormatMarkdown ChangelogFormat = "markdown" FormatBBCode ChangelogFormat = "bbcode" )
type ChangelogMarkdown ¶
type ChangelogMarkdown struct {
Changelog
}
func (ChangelogMarkdown) GetSemverGroups ¶
func (changelog ChangelogMarkdown) GetSemverGroups() map[changelog_types.ChangelogSectionType]*changelogSemverGroup
func (ChangelogMarkdown) Render ¶
func (changelog ChangelogMarkdown) Render() string
func (ChangelogMarkdown) RenderHeader ¶
func (changelog ChangelogMarkdown) RenderHeader() string
type IChangelog ¶
type IChangelog interface {
Render() string
GetSemverGroups() map[changelog_types.ChangelogSectionType]*changelogSemverGroup
}
func NewChangelogBBCode ¶
func NewChangelogBBCode( g *semanticgit.SemanticGit, semver_options semvertype.OptionsSemVer, config settings.ConfigScheme, FromTag types.TagName, ) IChangelog
func NewChangelogMarkdown ¶
func NewChangelogMarkdown( g *semanticgit.SemanticGit, semver_options semvertype.OptionsSemVer, config settings.ConfigScheme, FromTag types.TagName, ) IChangelog
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.