Add custom tag message #631

LuisHenri · 2022-12-04T14:48:23Z

Description

According to #558, I implemented a custom tag message for annotated tags.
Right now, the annotated tag is given as "tag_name" with its message as "tag_name" as well. It might be nice to have custom tag messages, for example, to add the features added on that tag.
The idea is a new argument to bump with the tag_message,

cz bump --annotated-tag-message "a message"
cz bump -atm "a message"

Checklist

Add test cases to all the changes you introduce
Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
Test the changes on the local machine manually
Update the documentation for the changes

Expected behavior

Running the following commands will create an annotated tag with "a message" as the message of the tag.

cz bump --annotated-tag-message "a message"
cz bump -atm "a message"

Steps to Test This Pull Request

Run cz bump -atm "a message"
Run git tag -l --format='%(contents:subject)' <the-created-tag-name>
Output should be 'a message'

Additional context

Based on Issue #558

Open questions:

Should I name the argument as --annotated-tag-message or as --annotated-tag-msg to keep it short?
For some reason, the Pipeline is not working correctly. I see that this is the case for other PRs as well. Is that really the case @Lee-W ?

Lee-W · 2022-12-29T10:44:14Z

Should I name the argument as --annotated-tag-message or as --annotated-tag-msg to keep it short?

I like --annotated-tag-message a bit more.

For some reason, the Pipeline is not working correctly. I see that this is the case for other PRs as well. Is that really the case @Lee-W ?

This should have been solved. Let me rebase your branch and see how it works.

Lee-W · 2022-12-29T10:47:52Z

Hi @LuisHenri ,tests/commands/test_bump_command.py::test_bump_changelog_command_commits_untracked_changelog_and_version_files failed even after rebasing. I might need your help to take a look at this issue. Thanks!

codecov · 2022-12-30T01:01:39Z

Codecov Report

Attention: 11 lines in your changes are missing coverage. Please review.

Files	Coverage Δ
commitizen/__version__.py	`100.00% <100.00%> (ø)`
commitizen/bump.py	`100.00% <100.00%> (ø)`
commitizen/changelog.py	`100.00% <100.00%> (+0.50%)`	⬆️
commitizen/changelog_formats/asciidoc.py	`100.00% <100.00%> (ø)`
commitizen/changelog_formats/base.py	`100.00% <100.00%> (ø)`
commitizen/changelog_formats/markdown.py	`100.00% <100.00%> (ø)`
commitizen/changelog_formats/restructuredtext.py	`100.00% <100.00%> (ø)`
commitizen/changelog_formats/textile.py	`100.00% <100.00%> (ø)`
commitizen/commands/bump.py	`97.71% <100.00%> (+0.06%)`	⬆️
commitizen/commands/changelog.py	`99.07% <100.00%> (+0.13%)`	⬆️
... and 25 more

📢 Thoughts on this report? Let us know!.

LuisHenri · 2022-12-30T01:38:24Z

Hi @LuisHenri ,tests/commands/test_bump_command.py::test_bump_changelog_command_commits_untracked_changelog_and_version_files failed even after rebasing. I might need your help to take a look at this issue. Thanks!

Hey @Lee-W,
I fixed it. Seems like one of the tests was trying to run bump --annotated instead of bump --annotated-tag.

commitizen/git.py

frerksaxen · 2023-06-07T10:21:32Z

I would really love to see this feature :)

LuisHenri · 2023-07-21T10:51:25Z

@Lee-W is something else needed still?

Lee-W · 2023-07-21T10:53:25Z

Hi @LuisHenri , sorry for the late review; I'm out of bandwidth these days. But I planned to take a look at a few PRs tomorrow. If you can rebase this PR and mention me, I'll take a look tomorrow. Thanks!

LuisHenri · 2023-07-25T02:36:37Z

@Lee-W Sorry for the delay. I'm done.

Lee-W · 2023-07-25T02:51:04Z

Hi @LuisHenri , instead of merging main branch, we prefer rebasing. You can do so through git rebase -i master

LuisHenri · 2023-07-25T18:44:50Z

@Lee-W Thanks for the advice! What about now? :)

Lee-W · 2023-07-26T00:21:52Z

@LuisHenri perfect! I'll try to take a deeper look this weekend.

Lee-W

Hi @LuisHenri , thanks for your contribution. the change looks good to me!

@woile I'm planning on merging this one these days. Let me know if you want to take a deeper look

tests/utils.py

woile · 2023-07-30T06:35:53Z

Is it possible to add a message to a light tag? If not, should we throw an error to inform the user?

Lee-W · 2023-08-20T07:43:31Z

@woile According to https://git-scm.com/book/en/v2/Git-Basics-Tagging, it seems we're not able to do that for a light tag

Lee-W · 2023-08-20T07:49:25Z

commitizen/git.py

    _opt = ""
    if annotated:
        _opt = f"-a {tag} -m"
    if signed:
        _opt = f"-s {tag} -m"
-    c = cmd.run(f"git tag {_opt} {tag}")
+
+    c = cmd.run(f'git tag {_opt} "{tag if _opt == "" or msg is None else msg}"')


@woile do you mean we should add a warning here to let the users know if they're using this feature, they're actually creating annotated tag?

To create a lightweight tag, don’t supply any of the -a, -s, or -m options, just provide a tag name:

https://git-scm.com/book/en/v2/Git-Basics-Tagging

not sure whether my understanding is correct

I see, maybe a comment there explaining that. I didn't know that if you provide a message it automatically becomes an annotated tag.

@woile I just added the comment and resolved the conflict. Could you please take a look? I think we're pretty close to merge this one :)

cc @noirbizarre

… given

Co-authored-by: Wei Lee <[email protected]>

…message

frerksaxen · 2023-11-20T08:29:07Z

@Lee-W git tag -m limits the tag annotation message to a one liner, correct? To have multiple lines you would need to allow multiple -m messages or provide a -F file. Or is it possible to line break with \n within the message string?

Lee-W · 2023-12-03T02:00:27Z

@Lee-W git tag -m limits the tag annotation message to a one liner, correct? To have multiple lines you would need to allow multiple -m messages or provide a -F file. Or is it possible to line break with \n within the message string?

Something like the following works

git commit -m "first line
second line
third line"

Lee-W · 2023-12-03T02:01:51Z

@woile @noirbizarre I'm planning on merging this one today. Please let me know if you want to take a look. Thanks!

LuisHenri mentioned this pull request Dec 4, 2022

tag message for annotated_tag option #558

Open

Lee-W added the issue-status: wait-for-response label Dec 29, 2022

Lee-W added pr-status: wait-for-review and removed issue-status: wait-for-response labels Dec 31, 2022

Lee-W reviewed Jan 21, 2023

View reviewed changes

commitizen/git.py Show resolved Hide resolved

Lee-W added issue-status: wait-for-response and removed pr-status: wait-for-review labels Jan 21, 2023

Lee-W added pr-status: wait-for-review and removed issue-status: wait-for-response labels Feb 8, 2023

github-actions bot added the issue-status: needs-triage label Jul 25, 2023

LuisHenri force-pushed the feat/custom-tag-message branch from 3716b1b to c064be5 Compare July 25, 2023 18:43

LuisHenri force-pushed the feat/custom-tag-message branch from 9d88ad3 to dead382 Compare July 25, 2023 18:53

Lee-W approved these changes Jul 29, 2023

View reviewed changes

tests/utils.py Outdated Show resolved Hide resolved

Lee-W added pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check and removed pr-status: wait-for-review issue-status: needs-triage labels Jul 29, 2023

github-actions bot added the issue-status: needs-triage label Jul 29, 2023

Lee-W removed the issue-status: needs-triage label Jul 30, 2023

Lee-W added pr-status: wait-for-response and removed pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check labels Jul 30, 2023

Lee-W reviewed Aug 20, 2023

View reviewed changes

Lee-W requested a review from woile November 6, 2023 00:25

LuisHenri and others added 15 commits November 6, 2023 22:48

feat: add custom message to annotated git tag

29997f6

fix(commitizen-git): add quotes for tag message

ffcf0ff

feat(git): add get tag message function

d7dc8b4

test(utils): add tag message parameters to create_tag function

22304f0

test(utils): add test for creating tag with message

8568427

feat: add tag message argument to cli

5b7991b

docs(bump): add documentation for annotated tag message

7037766

feat(commands-bump): automatically create annotated tag if message is…

b981a29

… given

refactor(commands-bump): cast str to bool

2b040cb

refactor(commands-bump): make changelog variable in 1 line

72455ba

test(git): fix tag with message test

1278f63

fix(test-bump-command): typo in --annotated-tag option inside test

e6b6c55

test(git): different output for tag message on Windows

29d12d1

docs: accept type hint suggestions

315493f

Co-authored-by: Wei Lee <[email protected]>

docs(git): add comment for not able to create a lightweight tag with …

976c2b2

…message

Lee-W force-pushed the feat/custom-tag-message branch from 23244b8 to 976c2b2 Compare November 6, 2023 14:57

github-actions bot added the pr-status: wait-for-review label Nov 6, 2023

Lee-W removed the pr-status: wait-for-response label Nov 6, 2023

Lee-W added pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check and removed pr-status: wait-for-review labels Dec 3, 2023

Lee-W merged commit 9a0164c into commitizen-tools:master Dec 3, 2023
18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add custom tag message #631

Add custom tag message #631

LuisHenri commented Dec 4, 2022 •

edited

Loading

Lee-W commented Dec 29, 2022

Lee-W commented Dec 29, 2022

codecov bot commented Dec 30, 2022 •

edited

Loading

LuisHenri commented Dec 30, 2022

frerksaxen commented Jun 7, 2023

LuisHenri commented Jul 21, 2023

Lee-W commented Jul 21, 2023

LuisHenri commented Jul 25, 2023

Lee-W commented Jul 25, 2023

LuisHenri commented Jul 25, 2023

Lee-W commented Jul 26, 2023

Lee-W left a comment

woile commented Jul 30, 2023

Lee-W commented Aug 20, 2023

Lee-W Aug 20, 2023

woile Nov 6, 2023

Lee-W Nov 6, 2023

frerksaxen commented Nov 20, 2023

Lee-W commented Dec 3, 2023

Lee-W commented Dec 3, 2023

Add custom tag message #631

Add custom tag message #631

Conversation

LuisHenri commented Dec 4, 2022 • edited Loading

Description

Checklist

Expected behavior

Steps to Test This Pull Request

Additional context

Lee-W commented Dec 29, 2022

Lee-W commented Dec 29, 2022

codecov bot commented Dec 30, 2022 • edited Loading

Codecov Report

LuisHenri commented Dec 30, 2022

frerksaxen commented Jun 7, 2023

LuisHenri commented Jul 21, 2023

Lee-W commented Jul 21, 2023

LuisHenri commented Jul 25, 2023

Lee-W commented Jul 25, 2023

LuisHenri commented Jul 25, 2023

Lee-W commented Jul 26, 2023

Lee-W left a comment

Choose a reason for hiding this comment

woile commented Jul 30, 2023

Lee-W commented Aug 20, 2023

Lee-W Aug 20, 2023

Choose a reason for hiding this comment

woile Nov 6, 2023

Choose a reason for hiding this comment

Lee-W Nov 6, 2023

Choose a reason for hiding this comment

frerksaxen commented Nov 20, 2023

Lee-W commented Dec 3, 2023

Lee-W commented Dec 3, 2023

LuisHenri commented Dec 4, 2022 •

edited

Loading

codecov bot commented Dec 30, 2022 •

edited

Loading