Skip to content

Commit 90b7288

Browse files
committed
docs: add upgrade guide
1 parent 153c742 commit 90b7288

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

docs/upgrade.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,51 @@
22

33
## Version 1 to 2
44

5+
```sh
6+
npm install --save-dev conventional-changelog-lint@latest
7+
```
8+
9+
### Breaking changes
10+
11+
#### CLI
12+
13+
* None
14+
15+
#### Config
16+
17+
* **wildcards** config is ignored - as of version `2.0.0` the former `.wildcards` configuration is ignored entirely. If your `.commitlintrc` or an extended shareable configuration has a `.wildcards` key a warning will be issued.
18+
19+
#### API
20+
21+
* None
22+
523
## Version 2 to 3
24+
25+
```sh
26+
npm remove --save-dev conventional-changelog-lint
27+
npm install --save commitlint
28+
mv .conventional-changelog-lintrc .commitlintrc
29+
```
30+
31+
* Rename all calls to `conventional-changelog-lint` to `commitlint`
32+
33+
### Breaking changes
34+
35+
#### CLI
36+
37+
* `conventional-changelog-lint` command now is called `commitlint`
38+
* `commitlint` command now is installed via `@commitlint/cli`
39+
* `.conventional-changelog-lintrc` now is called `.commitlintrc`
40+
* `--preset | -p` flag was removed. The `angular` preset is used always.
41+
42+
#### Config
43+
44+
* `.preset` key is removed. The `angular` preset is used always.
45+
46+
#### API
47+
48+
* `getConfiguration(name, settings, seed)` changed to `load(seed)`
49+
* `getMessages(range)` changed to `read(range)`
50+
* `getPreset(name, require)` removed
51+
* `format(report, options)` now only respects `.color` on `options`
52+
* `lint(message, options)` changed to `lint(message, rules)`

0 commit comments

Comments
 (0)