cybercinch/go-semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 14 Wiki Activity

feat(internal/changelog): add breaking changes to changelog

Browse Source
This commit is contained in:
Nightapes
2019-07-21 15:06:49 +02:00
parent ab14ab397c
commit 69db52e5b1
1 changed files with 37 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
internal/changelog/changelog.go
View File

@@ -15,6 +15,14 @@ import (
const defaultChangelogTitle string = `v{{.Version}} ({{.Now.Format "2006-01-02"}})` const defaultChangelogTitle string = `v{{.Version}} ({{.Now.Format "2006-01-02"}})`
const defaultChangelog string = `# v{{$.Version}} ({{.Now.Format "2006-01-02"}}) const defaultChangelog string = `# v{{$.Version}} ({{.Now.Format "2006-01-02"}})
{{ range $index,$commit := .BreakingChanges -}}
{{ if eq $index 0 }}
## BREAKING CHANGES
{{ end}}
* **{{$.Backtick}}{{$commit.Scope}}{{$.Backtick}}** {{$commit.ParsedBreakingChangeMessage}}
introduced by commit:
{{$commit.ParsedMessage}} {{if $.HasURL}} ([{{ printf "%.7s" $commit.Commit.Hash}}]({{ replace $.URL "{{hash}}" $commit.Commit.Hash}})) {{end}}
{{ end -}}
{{ range $key := .Order }} {{ range $key := .Order }}
{{ $commits := index $.Commits $key}} {{if $commits -}} {{ $commits := index $.Commits $key}} {{if $commits -}}
### {{ $key }} ### {{ $key }}
@@ -26,33 +34,37 @@ const defaultChangelog string = `# v{{$.Version}} ({{.Now.Format "2006-01-02"}})
` `
type changelogContent struct { type changelogContent struct {
Commits map[string][]analyzer.AnalyzedCommit Commits map[string][]analyzer.AnalyzedCommit
Order []string BreakingChanges []analyzer.AnalyzedCommit
Version string Order []string
Now time.Time Version string
Backtick string Now time.Time
HasURL bool Backtick string
URL string HasURL bool
URL string
} }
//Changelog struct //Changelog struct
type Changelog struct { type Changelog struct {
config *config.ReleaseConfig config *config.ReleaseConfig
rules []analyzer.Rule rules []analyzer.Rule
releaseTime time.Time
} }
//New Changelog struct for generating changelog from commits //New Changelog struct for generating changelog from commits
func New(config *config.ReleaseConfig, rules []analyzer.Rule) *Changelog { func New(config *config.ReleaseConfig, rules []analyzer.Rule, releaseTime time.Time) *Changelog {
return &Changelog{ return &Changelog{
config: config, config: config,
rules: rules, rules: rules,
releaseTime: releaseTime,
} }
} }
// GenerateChanglog from given commits // GenerateChanglog from given commits
func (c *Changelog) GenerateChanglog(templateConfig shared.ChangelogTemplateConfig, analyzedCommits map[string][]analyzer.AnalyzedCommit) (*shared.GeneratedChangelog, error) { func (c *Changelog) GenerateChanglog(templateConfig shared.ChangelogTemplateConfig, analyzedCommits map[analyzer.Release][]analyzer.AnalyzedCommit) (*shared.GeneratedChangelog, error) {
commitsPerScope := map[string][]analyzer.AnalyzedCommit{} commitsPerScope := map[string][]analyzer.AnalyzedCommit{}
commitsBreakingChange := []analyzer.AnalyzedCommit{}
order := make([]string, 0) order := make([]string, 0)
for _, rule := range c.rules { for _, rule := range c.rules {
@@ -65,6 +77,10 @@ func (c *Changelog) GenerateChanglog(templateConfig shared.ChangelogTemplateConf
for _, commits := range analyzedCommits { for _, commits := range analyzedCommits {
for _, commit := range commits { for _, commit := range commits {
if commit.Print { if commit.Print {
if commit.ParsedBreakingChangeMessage != "" {
commitsBreakingChange = append(commitsBreakingChange, commit)
continue
}
if _, ok := commitsPerScope[commit.TagString]; !ok { if _, ok := commitsPerScope[commit.TagString]; !ok {
commitsPerScope[commit.TagString] = make([]analyzer.AnalyzedCommit, 0) commitsPerScope[commit.TagString] = make([]analyzer.AnalyzedCommit, 0)
} }
@@ -74,13 +90,14 @@ func (c *Changelog) GenerateChanglog(templateConfig shared.ChangelogTemplateConf
} }
changelogContent := changelogContent{ changelogContent := changelogContent{
Version: templateConfig.Version, Version: templateConfig.Version,
Commits: commitsPerScope, Commits: commitsPerScope,
Now: time.Now(), Now: c.releaseTime,
Backtick: "`", BreakingChanges: commitsBreakingChange,
Order: order, Backtick: "`",
HasURL: templateConfig.CommitURL != "", Order: order,
URL: templateConfig.CommitURL, HasURL: templateConfig.CommitURL != "",
URL: templateConfig.CommitURL,
} }
title, err := generateTemplate(defaultChangelogTitle, changelogContent) title, err := generateTemplate(defaultChangelogTitle, changelogContent)