-
Notifications
You must be signed in to change notification settings - Fork 49
chore(deps): update conventional-changelog to v5.1.0
#246
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
base: master
Are you sure you want to change the base?
chore(deps): update conventional-changelog to v5.1.0
#246
Conversation
conventional-changelog to v5.1.0conventional-changelog to v5.1.0
|
Thanks for this! Apologies for missing it - I think I saw the title and assumed it was an automated update we couldn't apply 😅 Is this a breaking change for users who are using the API via jest (or other non-ESM-friendly environment)? It looks like it is to me, and I'm not sure how best to word the release notes. Happy to release this, though - what do you think we should say in the release notes? |
|
In theory there is no breaking change for users. As explained in conventional-changelog/conventional-changelog#1308 (comment), this should not affect users using Node 16 or above ( Unit testing was the only thing affected because Jest have the functionality behind an experiment flag (which I added in the script commands to solve it). After that, tests passed without issues.
I'm not sure what you meant by "jest API", so I can't answer about it. Are users able to generate a release notes (change log) through jest 🤔? |
Shouldn't it just say the same thing as any other dependency bump? Something like
or the same as the commit name
Here is an example of the current changelog file:commit-and-tag-version/CHANGELOG.md Lines 50 to 55 in 3bea4af
PS: I usually put dependencies updates as "chore", but it's ultimately up to you 😃 |
Right, yes - normally this would be the case. Unfortunately, the conventional-changelog dependencies for this repo are a bit special in that their interfaces are directly exposed - so some of their breaking changes are also breaking changes for us (this was a choice that was made when the original repo was part of
What I meant by this is that some tools (for example, Jest) don't play well with ESM libraries. So, importing this, I think would be a breaking change for those users. I'll try to find some time to do some testing. |
536af5d to
85745bc
Compare
package-lock.jsonin the commit so you can update it yourself.