You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`config`| NPM package name of a custom [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset. | - |
59
-
|`releaseRules`| An external module, a path to a module or an `Array` of rules. See [Commit types](#release-rules). | See [Commit types](#release-rules)|
59
+
|`releaseRules`| An external module, a path to a module or an `Array` of rules. See [Release rules](#release-rules). | See [Release rules](#release-rules)|
60
60
|`parserOpts`| Additional [conventional-commits-parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#conventionalcommitsparseroptions) options that will extends ones loaded by `preset` or `config`. See [Parser options](#parser-options). | - |
61
61
62
62
**NOTE:**`config` will be overwritten by the values of `preset`. You should use either `preset` or `config`, but not both. Individual properties of `parserOpts` will overwrite ones loaded with `preset` or `config`.
63
63
64
-
### Commit Types
64
+
### Release Rules
65
65
66
66
#### Rules definition
67
67
This is an `Array` of rule objects. A rule object has a `release` property and 1 or more criteria.
@@ -92,7 +92,7 @@ With the previous example:
92
92
93
93
#### Default rules matching
94
94
95
-
If a commit doesn't match any rule in `releaseRules` it will be evaluated agaisnt the [default commit types](lib/default/release-rules.js).
95
+
If a commit doesn't match any rule in `releaseRules` it will be evaluated agaisnt the [default release rules](lib/default/release-rules.js).
96
96
97
97
With the previous example:
98
98
* Commits with a breaking change will be associated with a `minor` release.
@@ -102,7 +102,7 @@ With the previous example:
102
102
103
103
#### No rules matching
104
104
105
-
If a commit doesn't match any rules in `releaseRules` or in [default commit types](lib/default/release-rules.js) then no release type will be associated with the commit.
105
+
If a commit doesn't match any rules in `releaseRules` or in [default release rules](lib/default/release-rules.js) then no release type will be associated with the commit.
106
106
107
107
With the previous example:
108
108
* Commits with `type` 'style' will not be associated with a release type.
@@ -140,10 +140,10 @@ For example with `eslint` preset:
140
140
With this configuration:
141
141
* Commits with `tag` 'Docs', that contains 'README' in their header message will be associated with a `patch` release.
142
142
* Commits with `tag` 'New' will be associated with a `patch` release.
143
-
* Commits with `tag` 'Breaking' will be associated with a `major` release (per [default commit types](lib/default/release-rules.js)).
144
-
* Commits with `tag` 'Fix' will be associated with a `patch` release (per [default commit types](lib/default/release-rules.js)).
145
-
* Commits with `tag` 'Update' will be associated with a `minor` release (per [default commit types](lib/default/release-rules.js)).
146
-
* Commits with `tag` 'New' will be associated with a `minor` release (per [default commit types](lib/default/release-rules.js)).
143
+
* Commits with `tag` 'Breaking' will be associated with a `major` release (per [default release rules](lib/default/release-rules.js)).
144
+
* Commits with `tag` 'Fix' will be associated with a `patch` release (per [default release rules](lib/default/release-rules.js)).
145
+
* Commits with `tag` 'Update' will be associated with a `minor` release (per [default release rules](lib/default/release-rules.js)).
146
+
* Commits with `tag` 'New' will be associated with a `minor` release (per [default release rules](lib/default/release-rules.js)).
147
147
* All other commits will not be associated with a release type.
0 commit comments