Skip to content

Commit 23cb7de

Browse files
committed
docs: add change for v8
1 parent c102d2f commit 23cb7de

File tree

5 files changed

+27
-8
lines changed

5 files changed

+27
-8
lines changed

docs/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,12 @@ echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitl
3333
echo 'foo: bar' | commitlint
3434
⧗ input: foo: bar
3535
type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] [type-enum]
36+
3637
✖ found 1 problems, 0 warnings
38+
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
39+
```
3740

41+
```bash
3842
# Lint last commit from history
3943
commitlint --from=HEAD~1
4044
```

docs/_sidebar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,5 @@
1313
* [Configuration](reference-configuration.md)
1414
* [Rules](reference-rules.md)
1515
* [API](reference-api.md)
16+
* [Plugins](reference-plugins.md)
1617
* [Examples](reference-examples.md)

docs/guides-local-setup.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,19 +49,25 @@ You can test the hook by simply committing. You should see something like this i
4949

5050
```bash
5151
git commit -m "foo: this will fail"
52-
husky > npm run -s commitmsg
53-
52+
husky > commit-msg (node v10.1.0)
53+
No staged files match any of provided globs.
5454
⧗ input: foo: this will fail
5555
type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] [type-enum]
56+
5657
✖ found 1 problems, 0 warnings
58+
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
5759

5860
husky > commit-msg hook failed (add --no-verify to bypass)
61+
```
5962

60-
git commit -m "chore: lint on commitmsg"
61-
husky > npm run -s commitmsg
63+
Since [v8.0.0](https://github.com/conventional-changelog/commitlint/releases/tag/v8.0.0) `commitlint` won't output anything if there is not problem with your commit.
64+
(You can use the `--verbose` flag to get positive output)
6265

63-
⧗ input: chore: lint on commitmsg
64-
✔ found 0 problems, 0 warnings
66+
```bash
67+
git commit -m "chore: lint on commitmsg"
68+
husky > pre-commit (node v10.1.0)
69+
No staged files match any of provided globs.
70+
husky > commit-msg (node v10.1.0)
6571
```
6672

6773
?> Local linting is fine for fast feedback but can easily be tinkered with. To ensure all commits are linted you'll want to check commits on an automated CI Server to. Learn how to in the [CI Setup guide](guides-ci-setup.md).

docs/guides-upgrade.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,11 @@ echo 'module.exports = {extends: ["@commitlint/config-conventional"]};';
161161

162162
* `config-angular` dropped support for the `chore` type, breaking compat with conventional-changelog,
163163
use `config-conventional` instead.
164+
165+
## Version 7 to 8
166+
167+
### Breaking changes
168+
169+
#### Output on succesful commit will be ommited
170+
171+
* You can use the `--verbose` flag to get positive output

docs/reference-cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```bash
44
❯ npx commitlint --help
55

6-
@commitlint@6.2.0 - Lint your commit messages
6+
@commitlint/cli@8.0.0 - Lint your commit messages
77

88
[input] reads from stdin if --edit, --env, --from and --to are omitted
99
--color, -c toggle colored output, defaults to: true
@@ -19,5 +19,5 @@
1919
--quiet, -q toggle console output
2020
--to, -t upper end of the commit range to lint; applies if edit=false
2121
--version, -v display version information
22-
--verbose, -V print summary and inputs for reports without problems
22+
--verbose, -V enable verbose output for reports without problems
2323
```

0 commit comments

Comments
 (0)