Skip to content

Commit b5fbaff

Browse files
authored
Add release name to release config (#17)
1 parent d78294c commit b5fbaff

File tree

4 files changed

+9
-1
lines changed

4 files changed

+9
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ tag: v0.1.0 # The tag number will be created. Required.
1313

1414
# # Optional fields:
1515
#
16-
# title: string # The release tile. Default is "Release ${tag}".
16+
# name: string # The release name. Default is empty.
17+
# title: string # The release title. Default is "Release ${tag}".
1718
# targetCommitish: string # The release commitish. Default is the merged commit.
1819
# releaseNote: string # The release body. Default is the auto-generated release note.
1920
# prerelease: bool # True if this is a prerelease. Default is false.
@@ -132,6 +133,7 @@ releaseNoteGenerator:
132133
133134
``` yaml
134135
tag: foo-v0.1.0
136+
name: foo
135137

136138
commitInclude:
137139
contains:

release.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ var (
3131

3232
type ReleaseConfig struct {
3333
Tag string `json:"tag,omitempty"`
34+
Name string `json:"name,omitempty"`
3435
Title string `json:"title,omitempty"`
3536
TargetCommitish string `json:"targetCommitish,omitempty"`
3637
ReleaseNote string `json:"releaseNote,omitempty"`
@@ -115,6 +116,7 @@ func parseReleaseConfig(data []byte) (*ReleaseConfig, error) {
115116

116117
type ReleaseProposal struct {
117118
Tag string `json:"tag,omitempty"`
119+
Name string `json:"name,omitempty"`
118120
Title string `json:"title,omitempty"`
119121
TargetCommitish string `json:"targetCommitish,omitempty"`
120122
ReleaseNote string `json:"releaseNote,omitempty"`
@@ -163,6 +165,7 @@ func buildReleaseProposal(ctx context.Context, releaseFile string, gitExecPath,
163165
releaseCommits := buildReleaseCommits(commits, *headCfg)
164166
p := ReleaseProposal{
165167
Tag: headCfg.Tag,
168+
Name: headCfg.Name,
166169
Title: headCfg.Title,
167170
TargetCommitish: headCfg.TargetCommitish,
168171
ReleaseNote: headCfg.ReleaseNote,

release_test.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ func TestParseReleaseConfig(t *testing.T) {
3939
configFile: "testdata/valid-config.txt",
4040
expected: &ReleaseConfig{
4141
Tag: "v1.1.0",
42+
Name: "hello",
4243
CommitInclude: ReleaseCommitMatcherConfig{
4344
Contains: []string{
4445
"app/hello",
@@ -100,6 +101,7 @@ func TestParseReleaseConfig(t *testing.T) {
100101
func TestBuildReleaseCommits(t *testing.T) {
101102
config := ReleaseConfig{
102103
Tag: "v1.1.0",
104+
Name: "hello",
103105
CommitInclude: ReleaseCommitMatcherConfig{
104106
Contains: []string{
105107
"app/hello",

testdata/valid-config.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
tag: v1.1.0
2+
name: hello
23

34
commitInclude:
45
contains:

0 commit comments

Comments
 (0)