feat: configurable types

pkg/generator/changelog_generator.go

@@ -2,7 +2,9 @@ package generator
 
 import (
 	"bytes"
+	"encoding/json"
 	"fmt"
+	"os"
 	"strings"
 	"text/template"
 	"time"
@@ -37,6 +39,7 @@ var CGVERSION = "dev"
 
 type DefaultChangelogGenerator struct {
 	emojis          bool
+	changelogTypes  *ChangelogTypes
 	formatCommitTpl *template.Template
 }
 
@@ -61,6 +64,19 @@ func (g *DefaultChangelogGenerator) Init(m map[string]string) error {
 	}
 	g.formatCommitTpl = parsedTemplate
 
+	if typesPath, ok := m["types_path"]; ok {
+		f, err := os.Open(typesPath)
+		if err != nil {
+			return fmt.Errorf("failed to open types_path: %v", err)
+		}
+		defer f.Close()
+		var changelogTypes ChangelogTypes
+		if err := json.NewDecoder(f).Decode(&changelogTypes); err != nil {
+			return fmt.Errorf("error parsing %s: %v", typesPath, err)
+		}
+		g.changelogTypes = &changelogTypes
+	}
+
 	return nil
 }
 
@@ -74,7 +90,7 @@ func (g *DefaultChangelogGenerator) Version() string {
 
 func (g *DefaultChangelogGenerator) Generate(changelogConfig *generator.ChangelogGeneratorConfig) string {
 	ret := fmt.Sprintf("## %s (%s)\n\n", changelogConfig.NewVersion, time.Now().UTC().Format("2006-01-02"))
-	clTypes := NewChangelogTypes()
+	clTypes := NewChangelogTypes(g.changelogTypes)
 	for _, commit := range changelogConfig.Commits {
 		if changelogConfig.LatestRelease.SHA == commit.SHA {
 			break

pkg/generator/changelog_generator_test.go

@@ -1,6 +1,8 @@
 package generator
 
 import (
+	"encoding/json"
+	"os"
 	"testing"
 	"text/template"
 
@@ -123,3 +125,26 @@ func TestFormatCommitWithCustomTemplate(t *testing.T) {
 	require.Contains(t, changelog, "* `12345678` - commit message [by @test]")
 	require.NotContains(t, changelog, "* `deadbeef` - commit message (deadbeef) [by @test]")
 }
+
+func TestFormatCommitWithCustomTypes(t *testing.T) {
+	myTypes := make(ChangelogTypes, len(defaultTypes))
+	copy(myTypes, defaultTypes)
+	for ix, clTy := range myTypes {
+		if clTy.Type == "feat" {
+			myTypes[ix].Text = "New Features"
+			break
+		}
+	}
+	typesFile, err := os.CreateTemp("", "changelog_types_*.json")
+	require.NoError(t, err)
+	defer os.Remove(typesFile.Name())
+	err = json.NewEncoder(typesFile).Encode(myTypes)
+	require.NoError(t, err)
+	typesFile.Close()
+
+	clGen := &DefaultChangelogGenerator{}
+	require.NoError(t, clGen.Init(map[string]string{"types_path": typesFile.Name()}))
+	changelog := clGen.Generate(testChangelogConfig)
+	require.Contains(t, changelog, "#### New Features")
+	require.NotContains(t, changelog, "#### Feature")
+}

pkg/generator/changelog_types.go

@@ -9,9 +9,13 @@ type ChangelogType struct {
 
 type ChangelogTypes []ChangelogType
 
-func NewChangelogTypes() ChangelogTypes {
-	ret := make(ChangelogTypes, len(defaultTypes))
-	copy(ret, defaultTypes)
+func NewChangelogTypes(overrideTypes *ChangelogTypes) ChangelogTypes {
+	src := &defaultTypes
+	if overrideTypes != nil {
+		src = overrideTypes
+	}
+	ret := make(ChangelogTypes, len(*src))
+	copy(ret, *src)
 	return ret
 }