Commit f74b9af

committed

fix(commit): resolve 'always_signoff' configuration and '-s' CLI issues

If 'always_signoff' is enabled in configurations, or '-s' is used alone on the CLI, the following errors arise due to 'git commit' argument failures : > signoff mechanic is deprecated, please use `cz commit -- -s` instead. > fatal: /tmp/...: '/tmp/... is outside repository at '...' Signed-off-by: Adrian DC <radian.dc@gmail.com>

1 parent 01fd042 commit f74b9afCopy full SHA for f74b9af

File tree

2 files changed

+32

-5

lines changed

commitizen/commands
- commit.py
tests/commands
- test_commit_command.py

2 files changed

+32

-5

lines changed

`‎commitizen/commands/commit.py‎`

Lines changed: 5 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -114,13 +114,15 @@ def __call__(self):`
`114`	`114`	`self.arguments.get("signoff") or self.config.settings["always_signoff"]`
`115`	`115`	`)`
`116`	`116`
	`117`	`+ extra_args = self.arguments.get("extra_cli_args", "")`
	`118`	`+`
`117`	`119`	`if signoff:`
`118`	`120`	`out.warn(`
`119`	`121`	"signoff mechanic is deprecated, please use `cz commit -- -s` instead."
`120`	`122`	`)`
`121`		`- extra_args=self.arguments.get("extra_cli_args", "--") +" -s"`
`122`		`- else:`
`123`		`- extra_args =self.arguments.get("extra_cli_args", "")`
	`123`	`+ ifextra_args:`
	`124`	`+ extra_args+=" "`
	`125`	`+ extra_args +="-s"`
`124`	`126`
`125`	`127`	`c = git.commit(m, args=extra_args)`
`126`	`128`

`‎tests/commands/test_commit_command.py‎`

Lines changed: 27 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -260,7 +260,7 @@ def test_commit_command_with_signoff_option(config, mocker: MockFixture):`
`260`	`260`
`261`	`261`	`commands.Commit(config, {"signoff": True})()`
`262`	`262`
`263`		`- commit_mock.assert_called_once_with(ANY, args="-- -s")`
	`263`	`+ commit_mock.assert_called_once_with(ANY, args="-s")`
`264`	`264`	`success_mock.assert_called_once()`
`265`	`265`
`266`	`266`
`@@ -283,7 +283,32 @@ def test_commit_command_with_always_signoff_enabled(config, mocker: MockFixture)`
`283`	`283`	`config.settings["always_signoff"] = True`
`284`	`284`	`commands.Commit(config, {})()`
`285`	`285`
`286`		`- commit_mock.assert_called_once_with(ANY, args="-- -s")`
	`286`	`+ commit_mock.assert_called_once_with(ANY, args="-s")`
	`287`	`+ success_mock.assert_called_once()`
	`288`	`+`
	`289`	`+`
	`290`	`+@pytest.mark.usefixtures("staging_is_clean")`
	`291`	`+def test_commit_command_with_gpgsign_and_always_signoff_enabled(`
	`292`	`+ config, mocker: MockFixture`
	`293`	`+):`
	`294`	`+ prompt_mock = mocker.patch("questionary.prompt")`
	`295`	`+ prompt_mock.return_value = {`
	`296`	`+ "prefix": "feat",`
	`297`	`+ "subject": "user created",`
	`298`	`+ "scope": "",`
	`299`	`+ "is_breaking_change": False,`
	`300`	`+ "body": "",`
	`301`	`+ "footer": "",`
	`302`	`+ }`
	`303`	`+`
	`304`	`+ commit_mock = mocker.patch("commitizen.git.commit")`
	`305`	`+ commit_mock.return_value = cmd.Command("success", "", b"", b"", 0)`
	`306`	`+ success_mock = mocker.patch("commitizen.out.success")`
	`307`	`+`
	`308`	`+ config.settings["always_signoff"] = True`
	`309`	`+ commands.Commit(config, {"extra_cli_args": "-S"})()`
	`310`	`+`
	`311`	`+ commit_mock.assert_called_once_with(ANY, args="-S -s")`
`287`	`312`	`success_mock.assert_called_once()`
`288`	`313`
`289`	`314`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit f74b9af

File tree

2 files changed

2 files changed

`‎commitizen/commands/commit.py‎`

`‎tests/commands/test_commit_command.py‎`

0 commit comments