shared

Documentation

Index

• type AnalyzedCommit
• type ChangelogTemplateConfig
• type Commit
• type GeneratedChangelog
• type MessageBlock
• type Release
• type ReleaseVersion
• type ReleaseVersionEntry
• type Scope

Types

type AnalyzedCommit

type AnalyzedCommit struct {
	Commit                      Commit                    `yaml:"commit"`
	ParsedMessage               string                    `yaml:"parsedMessage"`
	ParsedBreakingChangeMessage string                    `yaml:"parsedBreakingChangeMessage"`
	Tag                         string                    `yaml:"tag"`
	TagString                   string                    `yaml:"tagString"`
	Scope                       Scope                     `yaml:"scope"`
	Subject                     string                    `yaml:"subject"`
	MessageBlocks               map[string][]MessageBlock `yaml:"messageBlocks"`
	IsBreaking                  bool                      `yaml:"isBreaking"`
	Print                       bool                      `yaml:"print"`
}

AnalyzedCommit struct

type ChangelogTemplateConfig

type ChangelogTemplateConfig struct {
	CommitURL  string
	CompareURL string
	Hash       string
	Version    string
}

ChangelogTemplateConfig struct

type Commit

type Commit struct {
	Message string `yaml:"message"`
	Author  string `yaml:"author"`
	Hash    string `yaml:"hash"`
}

Commit struct

type GeneratedChangelog

type GeneratedChangelog struct {
	Title   string
	Content string
}

GeneratedChangelog struct

type MessageBlock

type MessageBlock struct {
	Label   string `yaml:"label"`
	Content string `yaml:"content"`
}

MessageBlock represents a block in the body section of a commit message

type Release

type Release string

Release types, like major

type ReleaseVersion

type ReleaseVersion struct {
	Last    ReleaseVersionEntry          `yaml:"last"`
	Next    ReleaseVersionEntry          `yaml:"next"`
	Branch  string                       `yaml:"branch"`
	Commits map[Release][]AnalyzedCommit `yaml:"commits"`
}

ReleaseVersion struct

type ReleaseVersionEntry

type ReleaseVersionEntry struct {
	Commit        string          `yaml:"commit"`
	VersionString string          `yaml:"version"`
	Version       *semver.Version `yaml:"-"`
}

ReleaseVersionEntry struct

type Scope

type Scope string

Scope of the commit, like feat, fix,..