Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add breaking changes message to changelog #112

Open
selimdoyranli opened this issue May 10, 2023 · 4 comments
Open

Add breaking changes message to changelog #112

selimdoyranli opened this issue May 10, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@selimdoyranli
Copy link

selimdoyranli commented May 10, 2023

breaking change

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?

@tmlmt
Copy link
Contributor

tmlmt commented Jul 3, 2023

This is already the case. That section will be added if you specify in your commit (see spec) that it introduces breaking changes.

@pi0
Copy link
Member

pi0 commented Jul 4, 2023

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.

@pi0 pi0 added documentation Improvements or additions to documentation question Further information is requested labels Jul 4, 2023
@pi0
Copy link
Member

pi0 commented Jul 4, 2023

I think would be nice if we add some little docs about semantic commits behavior in changelogen docs.

@lateek35
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants