Revert part of "align naming convention to git standard"

This reverts commit 9d72ea9.

Author: gpongelli

commitizen/cli.py

@@ -156,7 +156,7 @@
                         "action": "store_true",
                     },
                     {
-                        "name": ["--annotate", "-a"],
+                        "name": ["--annotated-tag", "-at"],
                         "help": "create annotated tag instead of lightweight one",
                         "action": "store_true",
                     },

commitizen/commands/bump.py

@@ -40,8 +40,8 @@ def __init__(self, config: BaseConfig, arguments: dict):
                     "prerelease",
                     "increment",
                     "bump_message",
-                    "annotate",
                     "gpg_sign",
+                    "annotated_tag",
                 ]
                 if arguments[key] is not None
             },
@@ -232,10 +232,10 @@ def __call__(self):  # noqa: C901
             raise BumpCommitFailedError(f'2nd git.commit error: "{c.err.strip()}"')
         c = git.tag(
             new_tag_version,
-            annotated=self.bump_settings.get("annotate", False)
-            or bool(self.config.settings.get("annotate", False)),
             signed=self.bump_settings.get("gpg_sign", False)
             or bool(self.config.settings.get("gpg_sign", False)),
+            annotated=self.bump_settings.get("annotated_tag", False)
+            or bool(self.config.settings.get("annotated_tag", False)),
         )
         if c.return_code != 0:
             raise BumpTagFailedError(c.err)

docs/bump.md

@@ -58,7 +58,7 @@ usage: cz bump [-h] [--dry-run] [--files-only] [--local-version] [--changelog]
                [--no-verify] [--yes] [--tag-format TAG_FORMAT]
                [--bump-message BUMP_MESSAGE] [--prerelease {alpha,beta,rc}]
                [--increment {MAJOR,MINOR,PATCH}] [--check-consistency]
-               [--annotate] [--sign] [--changelog-to-stdout] [--retry]
+               [--annotated-tag] [--gpg-sign] [--changelog-to-stdout] [--retry]
 
 options:
   -h, --help            show this help message and exit
@@ -82,8 +82,8 @@ options:
   --check-consistency, -cc
                         check consistency among versions defined in commitizen
                         configuration and version_files
-  --annotate, -a  create annotated tag instead of lightweight one
   --sign, -s  create a signed tag instead of lightweight one or annotated tag
+  --annotated-tag, -at  create annotated tag instead of lightweight one
   --changelog-to-stdout
                         Output changelog to the stdout
   --retry               retry commit if it fails the 1st time
@@ -163,9 +163,9 @@ version = "5.3.5+0.1.0"
 
 If `--local-version` is used, it will bump only the local version `0.1.0` and keep the public version `5.3.5` intact, bumping to the version `5.3.5+0.2.0`.
 
-### `--annotate`
+### `--annotated-tag`
 
-If `--annotate` is used, commitizen will create annotated tags. Also available via configuration, in `pyproject.toml` or `.cz.toml`.
+If `--annotated-tag` is used, commitizen will create annotated tags. Also available via configuration, in `pyproject.toml` or `.cz.toml`.
 
 ### `--changelog-to-stdout`
 
@@ -356,14 +356,12 @@ update_changelog_on_bump = true
 
 ---
 
-### `annotate`
+### `annotated_tag`
 
 When set to `true` commitizen will create annotated tags.
 
 ```toml
 [tool.commitizen]
-annotate = true
-```
 
 ---
 
@@ -374,6 +372,7 @@ When set to `true` commitizen will create gpg signed tags.
 ```toml
 [tool.commitizen]
 gpg_sign = true
+annotated_tag = true
 ```
 
 ## Custom bump

docs/config.md

@@ -123,14 +123,14 @@ commitizen:
 ## Settings
 
 | Variable                   | Type   | Default                     | Description                                                                                                                                                                                     |
-|----------------------------| ------ | --------------------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| -------------------------- | ------ | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `name`                     | `str`  | `"cz_conventional_commits"` | Name of the committing rules to use                                                                                                                                                             |
 | `version`                  | `str`  | `None`                      | Current version. Example: "0.1.2"                                                                                                                                                               |
 | `version_files`            | `list` | `[ ]`                       | Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [See more][version_files]                                                            |
 | `tag_format`               | `str`  | `None`                      | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more][tag_format]                                                                                  |
 | `update_changelog_on_bump` | `bool` | `false`                     | Create changelog when running `cz bump`                                                                                                                                                         |
-| `annotate`                 | `bool` | `false`                     | Use annotated tags instead of lightweight tags. [See difference][annotated-tags-vs-lightweight]                                                                                                 |
 | `sign`                     | `bool` | `false`                     | Use gpg signed tags instead of lightweight tags.                                                                                                                                                |
+| `annotated_tag`            | `bool` | `false`                     | Use annotated tags instead of lightweight tags. [See difference][annotated-tags-vs-lightweight]                                                                                                 |
 | `bump_message`             | `str`  | `None`                      | Create custom commit message, useful to skip ci. [See more][bump_message]                                                                                                                       |
 | `allow_abort`              | `bool` | `false`                     | Disallow empty commit messages, useful in ci. [See more][allow_abort]                                                                                                                           |
 | `changelog_file`           | `str`  | `CHANGELOG.md`              | filename of exported changelog                                                                                                                                                                  |

tests/commands/test_bump_command.py

@@ -59,7 +59,7 @@ def test_bump_minor_increment(commit_msg, mocker):
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_bump_minor_increment_annotated(commit_msg, mocker):
     create_file_and_commit(commit_msg)
-    testargs = ["cz", "bump", "--yes", "--annotate"]
+    testargs = ["cz", "bump", "--yes", "--annotated-tag"]
     mocker.patch.object(sys, "argv", testargs)
     cli.main()
     tag_exists = git.tag_exist("0.2.0")
@@ -90,7 +90,9 @@ def test_bump_minor_increment_annotated_config_file(
     commit_msg, mocker, tmp_commitizen_project
 ):
     tmp_commitizen_cfg_file = tmp_commitizen_project.join("pyproject.toml")
-    tmp_commitizen_cfg_file.write(f"{tmp_commitizen_cfg_file.read()}\n" f"gpg_sign = 1")
+    tmp_commitizen_cfg_file.write(
+        f"{tmp_commitizen_cfg_file.read()}\n" f"annotated_tag = 1"
+    )
     create_file_and_commit(commit_msg)
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)