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

tag message for annotated_tag option #558

Open
frerksaxen opened this issue Aug 16, 2022 · 8 comments
Open

tag message for annotated_tag option #558

frerksaxen opened this issue Aug 16, 2022 · 8 comments
Labels
type: feature A new enhacement proposal

Comments

@frerksaxen
Copy link

frerksaxen commented Aug 16, 2022

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

@frerksaxen frerksaxen added the type: feature A new enhacement proposal label Aug 16, 2022
@Lee-W
Copy link
Member

Lee-W commented 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
Copy link
Author

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

@LuisHenri
Copy link
Contributor

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

@Lee-W
Copy link
Member

Lee-W commented 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 LuisHenri mentioned this issue Dec 4, 2022
6 tasks
@LuisHenri
Copy link
Contributor

LuisHenri commented 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
Copy link
Member

Lee-W commented Dec 5, 2022

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

@yajo
Copy link
Contributor

yajo commented 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:

imagen

@Yunaido
Copy link

Yunaido commented Sep 17, 2024

any updates?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature A new enhacement proposal
Projects
None yet
Development

No branches or pull requests

5 participants