File: commit.md

package info (click to toggle)
commitizen 4.10.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,892 kB
  • sloc: python: 17,728; makefile: 15
file content (26 lines) | stat: -rw-r--r-- 690 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Commit Options

<!-- When adding a new option, please keep the alphabetical order. -->

## `breaking_change_exclamation_in_title`

- Type: `bool`
- Default: `False`

When true, breaking changes will be also indicated by an exclamation mark in the commit title (e.g., `feat!: breaking change`).

When false, breaking changes will be only indicated by `BREAKING CHANGE:` in the footer. See [writing commits](../tutorials/writing_commits.md) for more details.

## `encoding`

- Type: `str`
- Default: `"utf-8"`

Sets the character encoding to be used when parsing commit messages.

## `retry_after_failure`

- Type: `bool`
- Default: `False`

Retries failed commit when running `cz commit`.