Skip to content

Commit

Permalink
Add note about conventional-changelog-conventionalcommits override (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Feb 27, 2025
1 parent bf27526 commit 587be05
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@ In the [release-it][1] config, for example:
The plugin is a wrapper around conventional-changelog packages [conventional-recommended-bump][2],
[conventional-changelog-core][3] and more.

> [!IMPORTANT]
>
> For the `conventionalcommits` preset, you may need to override the version
> of the transitive `conventional-changelog-conventionalcommits` dependency, like so:
>
> ```json
> {
> "overrides": {
> "conventional-changelog-conventionalcommits": "8.0.0"
> }
> }
> ```
>
> Use `"resolutions"` for pnpm or Yarn.
## Contents
- [`preset`][4]
Expand Down

0 comments on commit 587be05

Please sign in to comment.