unjs
Add breaking changes message to changelog
Hi, "breaking changes" are important things for users to watch out for in new versions. i usually include them in the commit messages, but i think it would be useful to have a specific section to display them, like in the example image. Is there a way to do this?
This is already the case. That section will be added if you specify in your commit (see spec) that it introduces breaking changes.
Hi. In order to do this, you need to add an ! to the type in commit message like refactor!: change options interface. This will be automatically detected by changelogen to bump a major version + adding to the BREAKING CHANGES section.
I think would be nice if we add some little docs about semantic commits behavior in changelogen docs.
@pi0 It does add the commit into the Breaking changes section, but it doesn't provide the breaking change details if provided.
Like :
chore!: drop support for Node 6
BREAKING CHANGE: use JavaScript features not available in Node 6.
will generate:
⚠️ Breaking Changes
- ⚠️ drop support for Node 6 (beb780c3)
but use JavaScript features not available in Node 6. would not appear in the changelog. It seems unfortunate to mention that there's a breaking change if we couldn't provide any details about it.
Are there any updates on that? @lateek35 I am also looking for that behaviour as mentioned. I am currently rewriting a module and need to do some breaking changes. As it is a complete rewrite, I want to add the feature and declare all breaking changes in the body.
