Merge pull request #439 from manang/signoff

feat: add signoff parameter to commit command

Author: woile

commitizen/cli.py

@@ -49,6 +49,11 @@
                         "action": "store_true",
                         "help": "show output to stdout, no commit, no modified files",
                     },
+                    {
+                        "name": ["-s", "--signoff"],
+                        "action": "store_true",
+                        "help": "Sign off the commit",
+                    },
                 ],
             },
             {

commitizen/commands/commit.py

@@ -78,7 +78,12 @@ def __call__(self):
         if dry_run:
             raise DryRunExit()
 
-        c = git.commit(m)
+        signoff: bool = self.arguments.get("signoff")
+
+        if signoff:
+            c = git.commit(m, "-s")
+        else:
+            c = git.commit(m)
 
         if c.return_code != 0:
             out.error(c.err)

docs/README.md

@@ -86,6 +86,20 @@ or the shortcut
 cz c
 ```
 
+#### Sign off the commit
+
+Run in the terminal
+
+```bash
+cz commit --signoff
+```
+
+or the shortcut
+
+```bash
+cz commit -s
+```
+
 ### Integrating with Pre-commit
 Commitizen can lint your commit message for you with `cz check`.
 You can integrate this in your [pre-commit](https://pre-commit.com/) config with:

tests/commands/test_commit_command.py

@@ -107,6 +107,26 @@ def test_commit_command_with_dry_run_option(config, mocker):
         commit_cmd()
 
 
+@pytest.mark.usefixtures("staging_is_clean")
+def test_commit_command_with_signoff_option(config, mocker):
+    prompt_mock = mocker.patch("questionary.prompt")
+    prompt_mock.return_value = {
+        "prefix": "feat",
+        "subject": "user created",
+        "scope": "",
+        "is_breaking_change": False,
+        "body": "",
+        "footer": "",
+    }
+
+    commit_mock = mocker.patch("commitizen.git.commit")
+    commit_mock.return_value = cmd.Command("success", "", "", "", 0)
+    success_mock = mocker.patch("commitizen.out.success")
+
+    commands.Commit(config, {"signoff": True})()
+    success_mock.assert_called_once()
+
+
 def test_commit_when_nothing_to_commit(config, mocker):
     is_staging_clean_mock = mocker.patch("commitizen.git.is_staging_clean")
     is_staging_clean_mock.return_value = True