conventional-changelog/standard-version

How can I adjust the tag description/message?

rklec opened this issue · 1 comments

rklec commented

Problem

The tag prefix is adjustable and the version number is quite obvious to be in there.

However for the tag description it always uses the last commit (which in our version then is "chore: bump version to XY", which is quite useless to include IMHO).

Question

Instead, I want to include a custom arbitrary string in there. I would just like to pass it to standard-version to be used in the tag to-be-generated.

How can I do that?

Related

I found conventional-changelog/conventional-changelog#423 but this seems to be about the changelog and changing that there. Also #297 is about the commit to be generated and not the tag.

I could not find a duplicate of this issue.

rklec commented

Okay found --releaseCommitMessageFormat... (which BTW is not documented in the Readme, only --help shows it)

The code where this happens is apparently in:

standard-version/lib/lifecycles/tag.js

Line 24 in f5bff12

await runExecFile(args, 'git', ['tag', tagOption, args.tagPrefix + newVersion, '-m', `${formatCommitMessage(args.releaseCommitMessageFormat, newVersion)}`])

And I see no way that an arbitrary tag description/string is allowed here.
The only way that was added (#351) is changing the whole commit message, but that is obviously not what I want.

So I guess you can convert this into a feature request?