Skip to content

Commit d600a6b

Browse files
reconbotpvdlg
authored andcommitted
docs(readme): Add language describing default behavior for rules
1 parent 98ecfa1 commit d600a6b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Customizable commit-analyzer plugin for [semantic-release](https://github.com/se
1515

1616
## Options
1717

18-
By default `commit-analyzer` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md).
18+
By default `commit-analyzer` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md) and the [default rules](lib/default/release-rules.js) for release.
1919

2020
Additional options can be set within the plugin definition in `package.json` to use a different commit format and to customize it:
2121

@@ -48,6 +48,8 @@ Additional options can be set within the plugin definition in `package.json` to
4848

4949
### Release Rules
5050

51+
Release rules are used when deciding if the commits since the last release warrant a new release. If you define custom release rules the [default rules](lib/default/release-rules.js) will be used if nothing matched.
52+
5153
#### Rules definition
5254
This is an `Array` of rule objects. A rule object has a `release` property and 1 or more criteria.
5355
```json

0 commit comments

Comments
 (0)