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

Merge pull request #30 from jthurman42/jthurman/optional-scope

Browse Source 
Only print scope if one was defined
This commit is contained in:
Felix Wiedmann
2020-01-15 22:58:50 +01:00
committed by GitHub
parent af2addbffd d4627a9d46
commit 6a375f3bab
2 changed files with 34 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
internal/changelog/changelog.go
View File

@@ -18,15 +18,16 @@ const defaultCommitList string = `{{ range $index,$commit := .BreakingChanges -}
{{ if eq $index 0 }} {{ if eq $index 0 }}
## BREAKING CHANGES ## BREAKING CHANGES
{{ end}} {{ end}}
* **{{$.Backtick}}{{$commit.Scope}}{{$.Backtick}}** {{$commit.ParsedBreakingChangeMessage}} * {{ if $commit.Scope }}**{{$.Backtick}}{{$commit.Scope}}{{$.Backtick}}**{{ end }} {{$commit.ParsedBreakingChangeMessage}}
introduced by commit: introduced by commit:
{{$commit.ParsedMessage}} {{if $.HasURL}} ([{{ printf "%.7s" $commit.Commit.Hash}}]({{ replace $.URL "{{hash}}" $commit.Commit.Hash}})) {{end}} {{$commit.ParsedMessage}} {{if $.HasURL}} ([{{ printf "%.7s" $commit.Commit.Hash}}]({{ replace $.URL "{{hash}}" $commit.Commit.Hash}})){{end}}
{{ end -}} {{ end -}}
{{ range $key := .Order }} {{ range $key := .Order }}
{{ $commits := index $.Commits $key}} {{if $commits -}} {{ $commits := index $.Commits $key -}}
{{ if $commits }}
### {{ $key }} ### {{ $key }}
{{ range $index,$commit := $commits -}} {{ range $index,$commit := $commits }}
* **{{$.Backtick}}{{$commit.Scope}}{{$.Backtick}}** {{$commit.ParsedMessage}} {{if $.HasURL}} ([{{ printf "%.7s" $commit.Commit.Hash}}]({{ replace $.URL "{{hash}}" $commit.Commit.Hash}})) {{end}} * {{ if $commit.Scope}}**{{$.Backtick}}{{$commit.Scope}}{{$.Backtick}}** {{end}}{{$commit.ParsedMessage}}{{if $.HasURL}} ([{{ printf "%.7s" $commit.Commit.Hash}}]({{ replace $.URL "{{hash}}" $commit.Commit.Hash}})){{end}}
{{ end -}} {{ end -}}
{{ end -}} {{ end -}}
{{ end -}}` {{ end -}}`

33
internal/changelog/changelog_test.go
View File

@@ -32,7 +32,7 @@ func TestChangelog(t *testing.T) {
"minor": []shared.AnalyzedCommit{ "minor": []shared.AnalyzedCommit{
shared.AnalyzedCommit{ shared.AnalyzedCommit{
Commit: shared.Commit{ Commit: shared.Commit{
Message: "feat(test): my first commit", Message: "feat(internal/changelog): my first commit",
Author: "me", Author: "me",
Hash: "12345667", Hash: "12345667",
}, },
@@ -46,7 +46,30 @@ func TestChangelog(t *testing.T) {
}, },
result: &shared.GeneratedChangelog{ result: &shared.GeneratedChangelog{
Title: "v1.0.0 (2019-07-19)", Title: "v1.0.0 (2019-07-19)",
Content: "# v1.0.0 (2019-07-19)\n\n ### Features\n* **`internal/changelog`** my first commit ([1234566](https://commit.url)) \n\n ", Content: "# v1.0.0 (2019-07-19)\n\n\n### Features\n\n* **`internal/changelog`** my first commit ([1234566](https://commit.url))\n\n",
},
hasError: false,
},
{
testCase: "feat no scope",
analyzedCommits: map[shared.Release][]shared.AnalyzedCommit{
"minor": []shared.AnalyzedCommit{
shared.AnalyzedCommit{
Commit: shared.Commit{
Message: "feat: my first commit",
Author: "me",
Hash: "12345667",
},
ParsedMessage: "my first commit",
Tag: "feat",
TagString: "Features",
Print: true,
},
},
},
result: &shared.GeneratedChangelog{
Title: "v1.0.0 (2019-07-19)",
Content: "# v1.0.0 (2019-07-19)\n\n\n### Features\n\n* my first commit ([1234566](https://commit.url))\n\n",
}, },
hasError: false, hasError: false,
}, },
@@ -56,7 +79,7 @@ func TestChangelog(t *testing.T) {
"minor": []shared.AnalyzedCommit{ "minor": []shared.AnalyzedCommit{
shared.AnalyzedCommit{ shared.AnalyzedCommit{
Commit: shared.Commit{ Commit: shared.Commit{
Message: "feat(test): my first commit", Message: "feat(internal/changelog): my first commit",
Author: "me", Author: "me",
Hash: "12345667", Hash: "12345667",
}, },
@@ -68,7 +91,7 @@ func TestChangelog(t *testing.T) {
}, },
shared.AnalyzedCommit{ shared.AnalyzedCommit{
Commit: shared.Commit{ Commit: shared.Commit{
Message: "feat(test): my first break: BREAKING CHANGE: change api to v2", Message: "feat(internal/changelog): my first break: BREAKING CHANGE: change api to v2",
Author: "me", Author: "me",
Hash: "12345668", Hash: "12345668",
}, },
@@ -83,7 +106,7 @@ func TestChangelog(t *testing.T) {
}, },
result: &shared.GeneratedChangelog{ result: &shared.GeneratedChangelog{
Title: "v1.0.0 (2019-07-19)", Title: "v1.0.0 (2019-07-19)",
Content: "# v1.0.0 (2019-07-19)\n\n## BREAKING CHANGES\n\n* **`internal/changelog`** change api to v2 \nintroduced by commit: \nmy first break ([1234566](https://commit.url)) \n\n ### Features\n* **`internal/changelog`** my first commit ([1234566](https://commit.url)) \n\n ", Content: "# v1.0.0 (2019-07-19)\n\n## BREAKING CHANGES\n\n* **`internal/changelog`** change api to v2 \nintroduced by commit: \nmy first break ([1234566](https://commit.url))\n\n\n### Features\n\n* **`internal/changelog`** my first commit ([1234566](https://commit.url))\n\n",
}, },
hasError: false, hasError: false,
}, },