diff --git a/commitizen/cli.py b/commitizen/cli.py index 1d1ebe1f6..4bc38d7a1 100644 --- 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/tests/commands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt b/tests/commands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt index ebdb68446..d1c7fcd7f 100644 --- a/tests/commands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt +++ b/tests/commands/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.