Skip to content

docs: add change for v8 #685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,12 @@ echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitl
echo 'foo: bar' | commitlint
⧗ input: foo: bar
✖ type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] [type-enum]

✖ found 1 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
```

```bash
# Lint last commit from history
commitlint --from=HEAD~1
```
Expand Down
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@
* [Configuration](reference-configuration.md)
* [Rules](reference-rules.md)
* [API](reference-api.md)
* [Plugins](reference-plugins.md)
* [Examples](reference-examples.md)
18 changes: 12 additions & 6 deletions docs/guides-local-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,25 @@ You can test the hook by simply committing. You should see something like this i

```bash
git commit -m "foo: this will fail"
husky > npm run -s commitmsg

husky > commit-msg (node v10.1.0)
No staged files match any of provided globs.
⧗ input: foo: this will fail
✖ type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] [type-enum]

✖ found 1 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

husky > commit-msg hook failed (add --no-verify to bypass)
```

git commit -m "chore: lint on commitmsg"
husky > npm run -s commitmsg
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.
(You can use the `--verbose` flag to get positive output)

⧗ input: chore: lint on commitmsg
✔ found 0 problems, 0 warnings
```bash
git commit -m "chore: lint on commitmsg"
husky > pre-commit (node v10.1.0)
No staged files match any of provided globs.
husky > commit-msg (node v10.1.0)
```

?> 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).
8 changes: 8 additions & 0 deletions docs/guides-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,11 @@ echo 'module.exports = {extends: ["@commitlint/config-conventional"]};';

* `config-angular` dropped support for the `chore` type, breaking compat with conventional-changelog,
use `config-conventional` instead.

## Version 7 to 8

### Breaking changes

#### Output on succesful commit will be ommited

* You can use the `--verbose` flag to get positive output
4 changes: 2 additions & 2 deletions docs/reference-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
```bash
❯ npx commitlint --help

@commitlint@6.2.0 - Lint your commit messages
@commitlint/cli@8.0.0 - Lint your commit messages

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