fix(cli): shows deprecated text for -s, --signoff option

The deprecated text was not shown when `cz commit --help`
commitizen-tools · May 30, 2024 · 22d6d7e · 22d6d7e
1 parent 95eef05
commit 22d6d7e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/commitizen/cli.py b/commitizen/cli.py
@@ -149,7 +149,7 @@ def __call__(
                     {
                         "name": ["-s", "--signoff"],
                         "action": "store_true",
-                        "help": "sign off the commit",
+                        "help": "sign off the commit (deprecated: use `cz commit -- -s` instead)",
                     },
                     {
                         "name": ["-a", "--all"],

diff --git a/...mmands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt b/...mmands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt
@@ -12,7 +12,8 @@ options:
   --write-message-to-file FILE_PATH
                         write message to file before committing (can be
                         combined with --dry-run)
-  -s, --signoff         sign off the commit
+  -s, --signoff         sign off the commit (deprecated: use `cz commit -- -s`
+                        instead)
   -a, --all             Tell the command to automatically stage files that
                         have been modified and deleted, but new files you have
                         not told Git about are not affected.