Skip to content

Commit 976c2b2

Browse files
committed
docs(git): add comment for not able to create a lightweight tag with message
1 parent 315493f commit 976c2b2

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

commitizen/git.py

+3
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ def tag(
9191
if signed:
9292
_opt = f"-s {tag} -m"
9393

94+
# according to https://git-scm.com/book/en/v2/Git-Basics-Tagging,
95+
# we're not able to create lightweight tag with message.
96+
# by adding message, we make it a annotated tags
9497
c = cmd.run(f'git tag {_opt} "{tag if _opt == "" or msg is None else msg}"')
9598
return c
9699

0 commit comments

Comments
 (0)