Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How can I adjust the tag description/message? #889

Open
rklec opened this issue Mar 3, 2022 · 1 comment
Open

How can I adjust the tag description/message? #889

rklec opened this issue Mar 3, 2022 · 1 comment
Labels

Comments

@rklec
Copy link

rklec commented Mar 3, 2022

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 rklec added the question label Mar 3, 2022
@rklec
Copy link
Author

rklec commented Mar 3, 2022

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

The code where this happens is apparently in:

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?

@rklec rklec changed the title How can I adjust the tag description? How can I adjust the tag description/message? Mar 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

1 participant