Commit d3f2b68

crai0Lee-W

authored and

committed

docs: add retry_after_failure config and retry options for commit command

1 parent e6b5e8b commit d3f2b68Copy full SHA for d3f2b68

File tree

+16

-0

lines changed

+16

-0

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -29,3 +29,10 @@ For example, using the `-S` option on `git commit` to sign a commit is now commi
`29`	`29`	`!!! note`
`30`	`30`	Deprecation warning: A commit can be signed off using `cz commit --signoff` or the shortcut `cz commit -s`.
`31`	`31`	This syntax is now deprecated in favor of the new `cz commit -- -s` syntax.
	`32`	`+`
	`33`	`+### Retry`
	`34`	`+`
	`35`	+You can use `cz commit --retry` to reuse the last commit message when the previous commit attempt failed.
	`36`	+To automatically retry when running `cz commit`, you can set the `retry_after_failure`
	`37`	+configuration option to `true`. Running `cz commit --no-retry` makes commitizen ignore `retry_after_failure`, forcing
	`38`	`+a new commit message to be prompted.`

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -82,6 +82,14 @@ Default: `None`
`82`	`82`
`83`	`83`	`Create custom commit message, useful to skip ci. [Read more][bump_message]`
`84`	`84`
	`85`	+### `retry_after_failure`
	`86`	`+`
	`87`	+Type: `bool`
	`88`	`+`
	`89`	+Default: `false`
	`90`	`+`
	`91`	+Automatically retry failed commit when running `cz commit`. [Read more][retry_after_failure]
	`92`	`+`
`85`	`93`	### `allow_abort`
`86`	`94`
`87`	`95`	Type: `bool`
`@@ -380,6 +388,7 @@ setup(`
`380`	`388`	`[bump_message]: bump.md#bump_message`
`381`	`389`	`[major-version-zero]: bump.md#-major-version-zero`
`382`	`390`	`[prerelease-offset]: bump.md#-prerelease_offset`
	`391`	`+[retry_after_failure]: commit.md#retry`
`383`	`392`	`[allow_abort]: check.md#allow-abort`
`384`	`393`	`[version-scheme]: bump.md#version-scheme`
`385`	`394`	`[pre_bump_hooks]: bump.md#pre_bump_hooks`

Comments

(0)