Skip to content

Commit 587be05

Browse files
committed
Add note about conventional-changelog-conventionalcommits override (#110)
1 parent bf27526 commit 587be05

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,21 @@ In the [release-it][1] config, for example:
2424
The plugin is a wrapper around conventional-changelog packages [conventional-recommended-bump][2],
2525
[conventional-changelog-core][3] and more.
2626

27+
> [!IMPORTANT]
28+
>
29+
> For the `conventionalcommits` preset, you may need to override the version
30+
> of the transitive `conventional-changelog-conventionalcommits` dependency, like so:
31+
>
32+
> ```json
33+
> {
34+
> "overrides": {
35+
> "conventional-changelog-conventionalcommits": "8.0.0"
36+
> }
37+
> }
38+
> ```
39+
>
40+
> Use `"resolutions"` for pnpm or Yarn.
41+
2742
## Contents
2843
2944
- [`preset`][4]

0 commit comments

Comments
 (0)