feat(template): allow custom changelog template

README.md

@@ -110,9 +110,20 @@ assets:
 
 #### Changelog
 
+Following variables can be used for templates:
+*   `Commits` string
+*	`Version` string
+* 	`Now` time.Time
+* 	`Backtick` string
+* 	`HasDocker` bool
+* 	`HasDockerLatest` bool
+* 	`DockerRepository` string
+
 ```yml
 changelog:
   printAll: false ## Print all valid commits to changelog
+  title: "v{{.Version}} ({{.Now.Format "2006-01-02"}})" ## Used for releases (go template)
+  templatePath: "./examples/changelog.tmpl"    ## Path to a template file (go template)
 ```
 
 ##### Docker 

examples/changelog.tmpl

@@ -0,0 +1,16 @@
+# My custom release template v{{$.Version}} ({{.Now.Format "2006-01-02"}})
+{{ .Commits -}}
+{{ if .HasDocker}}
+## Docker image
+
+New docker image is released under {{$.Backtick}}{{.DockerRepository}}:{{.Version}}{{$.Backtick}}
+
+### Usage
+
+{{$.Backtick}}docker run {{.DockerRepository}}:{{.Version}}{{$.Backtick}}
+{{ if .HasDockerLatest}}
+or
+
+{{$.Backtick}}docker run {{.DockerRepository}}:latest{{$.Backtick}}
+{{ end -}}
+{{ end -}}

internal/changelog/changelog.go

@@ -2,6 +2,7 @@ package changelog
 
 import (
 	"bytes"
+	"io/ioutil"
 	"strings"
 	"text/template"
 	"time"
@@ -13,9 +14,7 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-const defaultChangelogTitle string = `v{{.Version}} ({{.Now.Format "2006-01-02"}})`
+const defaultCommitList string = `{{ range $index,$commit := .BreakingChanges -}}
-const defaultChangelog string = `# v{{$.Version}} ({{.Now.Format "2006-01-02"}})
-{{ range $index,$commit := .BreakingChanges -}}
 {{ if eq $index 0 }}
 ## BREAKING CHANGES
 {{ end}}
@@ -30,7 +29,10 @@ introduced by commit:
 * **{{$.Backtick}}{{$commit.Scope}}{{$.Backtick}}** {{$commit.ParsedMessage}} {{if $.HasURL}} ([{{ printf "%.7s" $commit.Commit.Hash}}]({{ replace $.URL "{{hash}}" $commit.Commit.Hash}}))  {{end}}
 {{ end -}}
 {{ end -}}
-{{ end -}}
+{{ end -}}`
+const defaultChangelogTitle string = `v{{.Version}} ({{.Now.Format "2006-01-02"}})`
+const defaultChangelog string = `# v{{$.Version}} ({{.Now.Format "2006-01-02"}})
+{{ .Commits -}}
 {{ if .HasDocker}}
 ## Docker image
 
@@ -48,19 +50,26 @@ or
 `
 
 type changelogContent struct {
-	Commits          map[string][]shared.AnalyzedCommit
+	Commits          string
-	BreakingChanges  []shared.AnalyzedCommit
-	Order            []string
 	Version          string
 	Now              time.Time
 	Backtick         string
-	HasURL           bool
-	URL              string
 	HasDocker        bool
 	HasDockerLatest  bool
 	DockerRepository string
 }
 
+type commitsContent struct {
+	Commits         map[string][]shared.AnalyzedCommit
+	BreakingChanges []shared.AnalyzedCommit
+	Order           []string
+	Version         string
+	Now             time.Time
+	Backtick        string
+	HasURL          bool
+	URL             string
+}
+
 //Changelog struct
 type Changelog struct {
 	config      *config.ReleaseConfig
@@ -108,30 +117,61 @@ func (c *Changelog) GenerateChanglog(templateConfig shared.ChangelogTemplateConf
 		}
 	}
 
+	commitsContent := commitsContent{
+		Version:         templateConfig.Version,
+		Commits:         commitsPerScope,
+		Now:             c.releaseTime,
+		BreakingChanges: commitsBreakingChange,
+		Backtick:        "`",
+		Order:           order,
+		HasURL:          templateConfig.CommitURL != "",
+		URL:             templateConfig.CommitURL,
+	}
+
 	changelogContent := changelogContent{
 		Version:          templateConfig.Version,
-		Commits:          commitsPerScope,
 		Now:              c.releaseTime,
-		BreakingChanges:  commitsBreakingChange,
 		Backtick:         "`",
-		Order:            order,
-		HasURL:           templateConfig.CommitURL != "",
-		URL:              templateConfig.CommitURL,
 		HasDocker:        c.config.Changelog.Docker.Repository != "",
 		HasDockerLatest:  c.config.Changelog.Docker.Latest,
 		DockerRepository: c.config.Changelog.Docker.Repository,
 	}
+	template := defaultChangelog
+	if c.config.Changelog.TemplatePath != "" {
+		content, err := ioutil.ReadFile(c.config.Changelog.TemplatePath)
+		if err != nil {
+			return nil, err
+		}
+		template = string(content)
+	}
 
-	title, err := generateTemplate(defaultChangelogTitle, changelogContent)
+	templateTitle := defaultChangelogTitle
+	if c.config.Changelog.TemplateTitle != "" {
+		templateTitle = c.config.Changelog.TemplateTitle
+	}
+
+	log.Debugf("Render title")
+	renderedTitle, err := generateTemplate(templateTitle, changelogContent)
 	if err != nil {
 		return nil, err
 	}
-	content, err := generateTemplate(defaultChangelog, changelogContent)
 
-	return &shared.GeneratedChangelog{Title: title, Content: content}, err
+	log.Debugf("Render commits")
+	renderedCommitList, err := generateTemplate(defaultCommitList, commitsContent)
+	if err != nil {
+		return nil, err
+	}
+
+	log.Tracef("Commits %s", renderedCommitList)
+
+	changelogContent.Commits = renderedCommitList
+	log.Debugf("Render changelog")
+	renderedContent, err := generateTemplate(template, changelogContent)
+
+	return &shared.GeneratedChangelog{Title: renderedTitle, Content: renderedContent}, err
 }
 
-func generateTemplate(text string, values changelogContent) (string, error) {
+func generateTemplate(text string, values interface{}) (string, error) {
 
 	funcMap := template.FuncMap{
 		"replace": replace,

pkg/config/config.go

@@ -10,11 +10,11 @@ import (
 
 // ChangelogConfig struct
 type ChangelogConfig struct {
-	PrintAll     bool            `yaml:"printAll,omitempty"`
+	PrintAll      bool            `yaml:"printAll,omitempty"`
-	Template     string          `yaml:"template,omitempty"`
+	TemplateTitle string          `yaml:"title,omitempty"`
-	TemplatePath string          `yaml:"templatePath,omitempty"`
+	TemplatePath  string          `yaml:"templatePath,omitempty"`
-	Docker       ChangelogDocker `yaml:"docker,omitempty"`
+	Docker        ChangelogDocker `yaml:"docker,omitempty"`
-	NPM          ChangelogNPM    `yaml:"npm,omitempty"`
+	NPM           ChangelogNPM    `yaml:"npm,omitempty"`
 }
 
 //ChangelogDocker type struct

pkg/config/config_test.go

@@ -74,9 +74,9 @@ github:
 		CommitFormat: "angular",
 		Branch:       map[string]string{"add_git_releases": "alpha", "alpha": "alpha", "beta": "beta", "master": "release", "rc": "rc"},
 		Changelog: config.ChangelogConfig{
-			PrintAll:     false,
+			PrintAll:      false,
-			Template:     "",
+			TemplateTitle: "",
-			TemplatePath: ""},
+			TemplatePath:  ""},
 		Release: "github",
 		GitHubProvider: config.GitHubProvider{
 			Repo:        "go-semantic-release",
@@ -92,20 +92,3 @@ github:
 	}, result)
 
 }
-
-// func TestWriteNotFound(t *testing.T) {
-
-// 	err := cache.Write("notfound/dir", shared.ReleaseVersion{
-// 		Last: shared.ReleaseVersionEntry{
-// 			Commit:  "12345",
-// 			Version: createVersion("1.0.0"),
-// 		},
-// 		Next: shared.ReleaseVersionEntry{
-// 			Commit:  "12346",
-// 			Version: createVersion("1.1.0"),
-// 		},
-// 		Branch: "master",
-// 	})
-// 	assert.Errorf(t, err, "Write non exsiting file")
-
-// }