Skip to main content

Breaking Changes

Breaking Changes

Active

Move backward-incompatible changes into a dedicated, clearly labeled group.

Command[tool.custy.changelog.breaking]

Category

Changelog Configuration

Quick Command

[tool.custy.changelog.breaking]

keywordsclassificationlabel

Properties​

Properties

PropertyTypeDescriptionDefaultRequired
enabledBooleanEnable active breaking-change classification and grouping.trueNo
keywordsString arrayCase-insensitive phrases searched in commit subjects and bodies.BREAKING CHANGE, BREAKING, INCOMPATIBLENo
labelStringConfigured section title retained in the breaking settings. Type mapping also defines the displayed breaking group title.âš ī¸ Breaking ChangesNo
Generated breaking configuration
toml
[tool.custy.changelog.breaking]
enabled = true
keywords = ["BREAKING CHANGE", "BREAKING", "INCOMPATIBLE"]
label = "âš ī¸ Breaking Changes"

Continue