semantic-release-lerna 2.6.2 → 2.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/dist/index.js +8437 -3924
- package/package.json +6 -8
package/README.md
CHANGED
|
@@ -74,6 +74,7 @@ The plugin can be configured in the [**semantic-release** configuration file](ht
|
|
|
74
74
|
|
|
75
75
|
| Option | Description | Default |
|
|
76
76
|
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
|
|
77
|
+
| `generateNotes` | Set to `true` to enable generating release notes. See `generateNotes` step for more details. | `false` |
|
|
77
78
|
| `npmVerifyAuth` | Set to `false` to disable verifying NPM registry credentials. | `true` |
|
|
78
79
|
| `latch` | Latches package versions together. If the version bump is at least the given version all packages will be bumped regardless if the package has been touched or not. `"major", "minor", "patch", "prerelease", "none"` | `"minor"` |
|
|
79
80
|
| `rootVersion` | Allow to update version on root `package.json`. | `true` |
|
|
@@ -86,3 +87,23 @@ The plugin can be configured in the [**semantic-release** configuration file](ht
|
|
|
86
87
|
|
|
87
88
|
Configure `@semantic-release/git` to commit `lerna.json` and `package.json` from the package folders.
|
|
88
89
|
See example configuration above.
|
|
90
|
+
|
|
91
|
+
### Error: Cannot modify immutable object
|
|
92
|
+
|
|
93
|
+
The contentional changelog packages have mismatching versions.
|
|
94
|
+
This plugin supports both `conventional-changelog-writer` v7 and v8 as long as the preset has a matching version.
|
|
95
|
+
|
|
96
|
+
Assuming you use `conventional-changelog-conventionalcommits` as preset you can verify this with:
|
|
97
|
+
|
|
98
|
+
npm ls conventional-changelog-writer conventional-changelog-commits
|
|
99
|
+
|
|
100
|
+
If the major version of the packages differs you need to explicitly install the correct versions:
|
|
101
|
+
|
|
102
|
+
npm install conventional-changelog-writer@8 conventional-changelog-commits@8
|
|
103
|
+
|
|
104
|
+
Substitute `@8` with `@7` if you need to stay on v7.
|
|
105
|
+
Usually you can get away with removing the packages from `package.json` afterwards as long as the lockfile (e.g. `package-lock.json`) still retains the requested versions of the packages.
|
|
106
|
+
|
|
107
|
+
If you do not have a configured preset `conventional-changelog-angular` is used by default, same rule applies, the major version has to be the same.
|
|
108
|
+
|
|
109
|
+
Also note that `semantic-release` v24 requires v8 of thte conventional changelog packages.
|