Shorthand for "BREAKING CHANGE:" #8

New Issue

GiteaMirror · 2026-02-17T11:31:15-06:00

GiteaMirror commented

2026-02-17 11:31:15 -06:00

Originally created by @koddsson on GitHub (Jun 23, 2017).

Could we add a "BREAK:" shorthand for "BREAKING CHANGE:"?

Reason being if I have a long component there's not a whole lot of space left to write a meaningful description for the CHANGELOG.

Originally created by @koddsson on GitHub (Jun 23, 2017). Could we add a "BREAK:" shorthand for "BREAKING CHANGE:"? Reason being if I have a long component there's not a whole lot of space left to write a meaningful description for the CHANGELOG.

GiteaMirror closed this issue

2026-02-17 11:31:15 -06:00

GiteaMirror commented

2026-02-17 11:31:17 -06:00

@koddsson commented on GitHub (Jun 26, 2017):

It got pointed out to me on twitter that you put BREAKING CHANGE: in the footer to signify a major version.

@koddsson commented on GitHub (Jun 26, 2017): It got pointed out to me on twitter that you put `BREAKING CHANGE:` in the footer to signify a major version.

GiteaMirror commented

2026-02-17 11:31:18 -06:00

@bcoe commented on GitHub (Jun 26, 2017):

@koddsson 👍 I haven't actually played with the footer stanza on my OSS projects (although I'd noticed it discussed in the Angular docs, and made sure to faithfully define its behavior).

Out of curiosity, what tool are you using for CHANGELOG generation, did using the footer work well?

@bcoe commented on GitHub (Jun 26, 2017): @koddsson 👍 I haven't actually played with the footer stanza on my OSS projects (although I'd noticed it discussed in the Angular docs, and made sure to faithfully define its behavior). Out of curiosity, what tool are you using for CHANGELOG generation, did using the footer work well?

GiteaMirror commented

2026-02-17 11:31:19 -06:00

@koddsson commented on GitHub (Jun 26, 2017):

I'm using lerna with the conventional-commits flag. It uses the conventional-commits-cli utility under the hood.

I haven't made a breaking change commit yet, but I think it should work :)

@koddsson commented on GitHub (Jun 26, 2017): I'm using `lerna` with the conventional-commits flag. It uses the [conventional-commits-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) utility under the hood. I haven't made a breaking change commit yet, but I think it should work :)

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/conventionalcommits.org#8