clog-tool / clog-cli

Generate beautiful changelogs from your Git commit history
MIT License
851 stars 43 forks source link

Breaking changes #76

Closed Ryman closed 8 years ago

Ryman commented 9 years ago

The conventional changelog description lists:

Breaking Changes are detected as such if the footer contains a line starting with BREAKING CHANGE: (with optional newlines) The rest of the commit message is then used for this.

I couldn't find anything in the repo referencing 'breaking', and the tool hasn't been picking them up, so I'm assuming this is unimplemented. Is this a missing feature, or have I overlooked something?

cburgdorf commented 9 years ago

Note that this is the repository for the CLI. Clog is split into library and CLI. This feature should actually be implemented. https://github.com/clog-tool/clog-lib/blob/ce5df5d02ce01914d3cf97d8502b9312bf64aa26/src/clog.rs#L130

Ryman commented 9 years ago

Ah, okay, but it looks like it's only used to find commits and there's no section in the outputted changelog though?

kbknapp commented 9 years ago

@Ryman correct. It would be a simple addition to actually output them in the changelog. I think the current implementation was a placeholder and just hasn't been changed to actually list them.

kbknapp commented 8 years ago

Leaving this open for tracking, but it's actually https://github.com/clog-tool/clog-lib/issues/5

kbknapp commented 8 years ago

Closed with https://github.com/clog-tool/clog-lib/issues/5 and 0.9.1 on crates.io