Skip to content

Commit c3107fc

Browse files
committed
docs: add upgrage guide for version 4 to 5
1 parent d0e62fd commit c3107fc

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Diff for: docs/guides-upgrade.md

+15
Original file line numberDiff line numberDiff line change
@@ -146,3 +146,18 @@ mv .conventional-changelog-lintrc commitlint.config.js
146146
* `getPreset(name, require)` removed
147147
* `format(report, options)` now only respects `.color` on `options`
148148
* `lint(message, options)` changed to `lint(message, rules)`
149+
150+
## Version 4 to 5
151+
152+
```bash
153+
npm remove --save-dev @commitlint/config-angular
154+
npm install --save @commitlint/cli @commitlint/config-conventional
155+
echo 'module.exports = {extends: ["@commitlint/config-conventional"]};';
156+
```
157+
158+
### Breaking changes
159+
160+
#### Config
161+
162+
* `config-angular` dropped support for the `chore` type, breaking compat with conventional-changelog,
163+
use `config-conventional` instead.

0 commit comments

Comments
 (0)