Skip to content

commit.md

Latest commit

 

History

History
37 lines (22 loc) · 996 Bytes

commit.md

File metadata and controls

37 lines (22 loc) · 996 Bytes

Commit Options

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 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.

message_length_limit

  • Type: int
  • Default: 0 (no limit)

Maximum length of the commit message. Setting it to 0 disables the length limit. This value must be a non-negative integer (>= 0).

!!! note This option can be overridden by the -l/--message-length-limit command line argument.