question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

tag message for annotated_tag option

See original GitHub issue

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

Issue Analytics

  • State:open
  • Created a year ago
  • Reactions:1
  • Comments:6 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
frerksaxencommented, Aug 17, 2022

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

0reactions
Lee-Wcommented, Dec 5, 2022

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

Read more comments on GitHub >

github_iconTop Results From Across the Web

Git - Tagging - Git SCM
Annotated tags, however, are stored as full objects in the Git database. They're checksummed; contain the tagger name, email, and date; have a...
Read more >
git tag | Atlassian Git Tutorial
Annotated tags are stored as full objects in the Git database. To reiterate, They store extra meta data such as: the tagger name,...
Read more >
What is the difference between an annotated and unannotated ...
The difference between the commands is that one provides you with a tag message while the other doesn't. An annotated tag has a...
Read more >
Git Tagging Explained - Initial Commit
Annotated tags allow you to include messages with each tag in similar fashion to commit messages, and also stores the tagger name, ...
Read more >
How to List, Create, Remove, and Show Tags in Git
Create a tag. You can create two type of tags: annotated and lightweight. They first ones are compete objects in GIT database: they...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found