| | | 1 | | package changelog |
| | | 2 | | |
| | | 3 | | import ( |
| | | 4 | | "bytes" |
| | | 5 | | "fmt" |
| | | 6 | | "strings" |
| | | 7 | | "text/template" |
| | | 8 | | "time" |
| | | 9 | | |
| | | 10 | | "github.com/jedi-knights/go-semantic-release/internal/domain" |
| | | 11 | | "github.com/jedi-knights/go-semantic-release/internal/ports" |
| | | 12 | | ) |
| | | 13 | | |
| | | 14 | | // Compile-time interface compliance check. |
| | | 15 | | var _ ports.ChangelogGenerator = (*TemplateGenerator)(nil) |
| | | 16 | | |
| | | 17 | | const defaultTemplate = `## {{if .Project}}[{{.Project}}] {{end}}{{.Version}} ({{.Date}}) |
| | | 18 | | {{range .Sections}} |
| | | 19 | | ### {{.Title}} |
| | | 20 | | |
| | | 21 | | {{range .Commits}}- {{if .Scope}}**{{.Scope}}:** {{end}}{{.Description}} ({{.ShortHash}}) |
| | | 22 | | {{end}}{{end}}` |
| | | 23 | | |
| | | 24 | | // TemplateGenerator implements ports.ChangelogGenerator using Go templates. |
| | | 25 | | type TemplateGenerator struct { |
| | | 26 | | customTemplate string |
| | | 27 | | } |
| | | 28 | | |
| | | 29 | | // NewTemplateGenerator creates a changelog generator with an optional custom template. |
| | | 30 | | func NewTemplateGenerator(customTemplate string) *TemplateGenerator { |
| | | 31 | | return &TemplateGenerator{customTemplate: customTemplate} |
| | | 32 | | } |
| | | 33 | | |
| | | 34 | | type templateData struct { |
| | | 35 | | Version string |
| | | 36 | | Project string |
| | | 37 | | Date string |
| | | 38 | | Sections []sectionData |
| | | 39 | | } |
| | | 40 | | |
| | | 41 | | type sectionData struct { |
| | | 42 | | Title string |
| | | 43 | | Commits []commitData |
| | | 44 | | } |
| | | 45 | | |
| | | 46 | | type commitData struct { |
| | | 47 | | Hash string |
| | | 48 | | ShortHash string |
| | | 49 | | Type string |
| | | 50 | | Scope string |
| | | 51 | | Description string |
| | | 52 | | Author string |
| | | 53 | | Breaking bool |
| | | 54 | | } |
| | | 55 | | |
| | | 56 | | func (g *TemplateGenerator) Generate( |
| | | 57 | | version domain.Version, |
| | | 58 | | project string, |
| | | 59 | | commits []domain.Commit, |
| | | 60 | | sections []domain.ChangelogSectionConfig, |
| | 10 | 61 | | ) (string, error) { |
| | 10 | 62 | | data := g.buildTemplateData(version, project, commits, sections) |
| | 10 | 63 | | |
| | 10 | 64 | | tmplStr := defaultTemplate |
| | 2 | 65 | | if g.customTemplate != "" { |
| | 2 | 66 | | tmplStr = g.customTemplate |
| | 2 | 67 | | } |
| | | 68 | | |
| | 10 | 69 | | tmpl, err := template.New("changelog").Parse(tmplStr) |
| | 1 | 70 | | if err != nil { |
| | 1 | 71 | | return "", fmt.Errorf("parsing changelog template: %w", err) |
| | 1 | 72 | | } |
| | | 73 | | |
| | 9 | 74 | | var buf bytes.Buffer |
| | 0 | 75 | | if err := tmpl.Execute(&buf, data); err != nil { |
| | 0 | 76 | | return "", fmt.Errorf("executing changelog template: %w", err) |
| | 0 | 77 | | } |
| | 9 | 78 | | return strings.TrimSpace(buf.String()), nil |
| | | 79 | | } |
| | | 80 | | |
| | | 81 | | func (g *TemplateGenerator) buildTemplateData( |
| | | 82 | | version domain.Version, |
| | | 83 | | project string, |
| | | 84 | | commits []domain.Commit, |
| | | 85 | | sections []domain.ChangelogSectionConfig, |
| | 10 | 86 | | ) templateData { |
| | 10 | 87 | | // Group breaking changes separately. |
| | 10 | 88 | | breakingCommits := filterBreakingCommits(commits) |
| | 10 | 89 | | commitsByType := groupCommitsByType(commits) |
| | 10 | 90 | | |
| | 10 | 91 | | secs := make([]sectionData, 0, len(sections)) |
| | 10 | 92 | | for _, sec := range sections { |
| | 63 | 93 | | if sec.Hidden { |
| | 63 | 94 | | continue |
| | | 95 | | } |
| | | 96 | | |
| | 45 | 97 | | var sectionCommits []domain.Commit |
| | 9 | 98 | | if sec.Type == "breaking" { |
| | 9 | 99 | | sectionCommits = breakingCommits |
| | 9 | 100 | | } else { |
| | 36 | 101 | | sectionCommits = commitsByType[sec.Type] |
| | 36 | 102 | | } |
| | | 103 | | |
| | 38 | 104 | | if len(sectionCommits) == 0 { |
| | 38 | 105 | | continue |
| | | 106 | | } |
| | | 107 | | |
| | 7 | 108 | | secs = append(secs, sectionData{ |
| | 7 | 109 | | Title: sec.Title, |
| | 7 | 110 | | Commits: toCommitData(sectionCommits), |
| | 7 | 111 | | }) |
| | | 112 | | } |
| | | 113 | | |
| | 10 | 114 | | return templateData{ |
| | 10 | 115 | | Version: version.String(), |
| | 10 | 116 | | Project: project, |
| | 10 | 117 | | Date: time.Now().Format("2006-01-02"), |
| | 10 | 118 | | Sections: secs, |
| | 10 | 119 | | } |
| | | 120 | | } |
| | | 121 | | |
| | | 122 | | func filterBreakingCommits(commits []domain.Commit) []domain.Commit { |
| | | 123 | | var result []domain.Commit |
| | | 124 | | for i := range commits { |
| | | 125 | | if commits[i].IsBreakingChange { |
| | | 126 | | result = append(result, commits[i]) |
| | | 127 | | } |
| | | 128 | | } |
| | | 129 | | return result |
| | | 130 | | } |
| | | 131 | | |
| | | 132 | | func groupCommitsByType(commits []domain.Commit) map[string][]domain.Commit { |
| | | 133 | | groups := make(map[string][]domain.Commit) |
| | | 134 | | for i := range commits { |
| | | 135 | | if commits[i].Type != "" { |
| | | 136 | | groups[commits[i].Type] = append(groups[commits[i].Type], commits[i]) |
| | | 137 | | } |
| | | 138 | | } |
| | | 139 | | return groups |
| | | 140 | | } |
| | | 141 | | |
| | | 142 | | func toCommitData(commits []domain.Commit) []commitData { |
| | | 143 | | result := make([]commitData, 0, len(commits)) |
| | | 144 | | for i := range commits { |
| | | 145 | | short := commits[i].Hash |
| | | 146 | | if len(short) > 7 { |
| | | 147 | | short = short[:7] |
| | | 148 | | } |
| | | 149 | | result = append(result, commitData{ |
| | | 150 | | Hash: commits[i].Hash, |
| | | 151 | | ShortHash: short, |
| | | 152 | | Type: commits[i].Type, |
| | | 153 | | Scope: commits[i].Scope, |
| | | 154 | | Description: commits[i].Description, |
| | | 155 | | Author: commits[i].Author, |
| | | 156 | | Breaking: commits[i].IsBreakingChange, |
| | | 157 | | }) |
| | | 158 | | } |
| | | 159 | | return result |
| | | 160 | | } |