Skip to content

Commit 8449080

Browse files
committed
fix(cli): shows deprecated text for -s, --signoff option
The deprecated text was not shown when `cz commit --help`
1 parent 08d86ad commit 8449080

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

commitizen/cli.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ def __call__(
149149
{
150150
"name": ["-s", "--signoff"],
151151
"action": "store_true",
152-
"help": "sign off the commit",
152+
"help": "sign off the commit (deprecated: use `cz commit -- -s` instead)",
153153
},
154154
{
155155
"name": ["-a", "--all"],

tests/commands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ options:
1212
--write-message-to-file FILE_PATH
1313
write message to file before committing (can be
1414
combined with --dry-run)
15-
-s, --signoff sign off the commit
15+
-s, --signoff sign off the commit (deprecated: use `cz commit -- -s`
16+
instead)
1617
-a, --all Tell the command to automatically stage files that
1718
have been modified and deleted, but new files you have
1819
not told Git about are not affected.

0 commit comments

Comments
 (0)