tag message for annotated_tag option
See original GitHub issueDescription
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
Issue Analytics
- State:
- Created a year ago
- Reactions:1
- Comments:6 (3 by maintainers)
Top GitHub Comments
@Lee-W Sure. I changed the original Description. Hope it’s much clearer now.
Sounds great! I’ll take a deeper look when I have time. Thanks!