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

…message
commitizen-tools · Dec 3, 2023 · 9a0164c · 9a0164c
1 parent 3fd0779
commit 9a0164c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/commitizen/git.py b/commitizen/git.py
@@ -91,6 +91,9 @@ def tag(
     if signed:
         _opt = f"-s {tag} -m"
 
+    # according to https://git-scm.com/book/en/v2/Git-Basics-Tagging,
+    # we're not able to create lightweight tag with message.
+    # by adding message, we make it a annotated tags
     c = cmd.run(f'git tag {_opt} "{tag if _opt == "" or msg is None else msg}"')
     return c