Isn't the default release name the tag?

[PaulRBerg]

Description

The README currently says that the default value of RELEASE_NAME is the empty string (""), however I don't think that this is the case.

I've recently used git-release with the first example workflow suggested here, and the title of the generated release was the tag itself.

For the avoidance of doubt - I like it that it uses the tag, it's just that I think the documentation for the RELEASE_NAME env var should be updated to reflect this behavior.

Side note: will you enable discussions in this repository? I would have preferred to create a discussion rather than an issue.

Reference

• https://github.com/PaulRBerg/prb-contracts/actions/runs/4112921082
• https://github.com/PaulRBerg/prb-contracts/releases/tag/v5.0.2

[anton-yurchenko]

Hello @PaulRBerg,
I have enabled discussions and migrated your issue. It was an excellent recommendation, thanks.

git-release creates releases with the name of the tag.
You might add a text before or after the tag using RELEASE_NAME_PREFIX and RELEASE_NAME_SUFFIX options.
Alternatively, you may have full control using RELEASE_NAME setting.

This behavior is different when working with UNRELEASED option, as the tag should be updated to the HEAD.
Release will be called Latest in this situation. However, you can still control it using RELEASE_NAME.

Here the section responsible for this logic:

git-release/release/release.go

Lines 46 to 52 in 1493c18

	if name != "" {
	release.Name = name
	} else if unreleased {
	release.Name = "Latest"
	} else {
	release.Name = fmt.Sprintf("%v%v%v", namePrefix, release.Reference.Tag, nameSuffix)
	}

I hope this clarifies this confusion.

[PaulRBerg]

Yup, all clear now, thanks for taking the time to write this answer up, @anton-yurchenko.

I'm glad you like the discussions idea.