commitizen icon indicating copy to clipboard operation
commitizen copied to clipboard

tag message for annotated_tag option

Open frerksaxen opened this issue 2 years ago • 8 comments

Description

Currently, with cz bump --annotated-tag, a tag will be created with the tag message being like the tag itself, just the new version. It's basically git tag -a -m <version> <version>. However, git provides the possibility of adding elaborate messages to the annotated tag: git tag -a -m <message> <version>. It would be great if we could add custom tag messages that could include:

  • the changelog
  • custom messages
  • author and date

Possible Solution

Maybe adding custom messages: cz bump --annotated-tag-msg "This new version will improve your life." Maybe adding the changelog: cz bump --annotated-tag-changelog Maybe adding author and date: cz bump --annotated-tag-credentials

And maybe everything combined: cz bump --annotated-tag-msg "This new version will improve your life." --annotated-tag-changelog --annotated-tag-credentials

might result in the git tag: 2.32.0 with the tag message:

This new version will improve your life.
Changelog:
2.32.0 (2022-08-18)
Feat:
- annotated-tag-msg <message> adds custom message to annotated git tag
- annotated-tag-changelog adds changelog to annotated git tag
- annotated-tag-credentials adds author and date to annotated git tag
Author/Date:
BestProgrammerEver/2022-08-18

Additional context

No response

Additional context

This is related to the following pull request: https://github.com/commitizen-tools/commitizen/pull/272

frerksaxen avatar Aug 16 '22 07:08 frerksaxen

Hi @frerksaxen , thanks for the feedback. I'm afraid I did not get the point. Could you please add some examples so that we could take a look?

Lee-W avatar Aug 16 '22 09:08 Lee-W

@Lee-W Sure. I changed the original Description. Hope it's much clearer now.

frerksaxen avatar Aug 17 '22 08:08 frerksaxen

I agree with the idea of adding a message apart from the tag_name

LuisHenri avatar Nov 30 '22 16:11 LuisHenri

Hi, I'm good with the high-level idea. But might need some more discussion on how the detail would be implemented

Lee-W avatar Dec 03 '22 06:12 Lee-W

@Lee-W Hi, I forked it and created the PR! :) #631 It doesn't implement all the functionalities listen in here, but I guess it can be split up in other PRs.

LuisHenri avatar Dec 04 '22 14:12 LuisHenri

Sounds great! I'll take a deeper look when I have time. Thanks!

Lee-W avatar Dec 05 '22 00:12 Lee-W

FWIW you can look in this page how that'd look in Gitlab: https://gitlab.gnome.org/GNOME/geary/-/tags

Annotated screenshot about annotated tags:

imagen

yajo avatar Oct 03 '23 07:10 yajo