Repository navigation
tag message for annotated_tag option #558
Description
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: #272
Activity
Lee-W commentedon Aug 16, 2022
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?
frerksaxen commentedon Aug 17, 2022
@Lee-W Sure. I changed the original Description. Hope it's much clearer now.
LuisHenri commentedon Nov 30, 2022
I agree with the idea of adding a message apart from the tag_name
Lee-W commentedon Dec 3, 2022
Hi, I'm good with the high-level idea. But might need some more discussion on how the detail would be implemented
LuisHenri commentedon Dec 4, 2022
@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.
Lee-W commentedon Dec 5, 2022
Sounds great! I'll take a deeper look when I have time. Thanks!
yajo commentedon Oct 3, 2023
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:
Yunaido commentedon Sep 17, 2024
any updates?
shoriminimoe commentedon May 21, 2025
This appears to be completed by #631
Lee-W commentedon May 21, 2025
oh, thanks for reminding us! I'll close this issue. but feel free to file a new one or reopen if it's not actually completed.