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
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Customizable commit-analyzer plugin for [semantic-release](https://github.com/se
8
8
9
9
## Options
10
10
11
-
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.
11
+
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.
12
12
13
13
Additional options can be set within the plugin definition in `package.json` to use a different commit format and to customize it:
14
14
@@ -41,7 +41,7 @@ Additional options can be set within the plugin definition in `package.json` to
41
41
42
42
### Release Rules
43
43
44
-
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.
44
+
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.
45
45
46
46
#### Rules definition
47
47
This is an `Array` of rule objects. A rule object has a `release` property and 1 or more criteria.
@@ -63,7 +63,7 @@ This is an `Array` of rule objects. A rule object has a `release` property and 1
63
63
64
64
Each commit will be compared with each rule and when it matches, the commit will be associated with the release type in the rule's `release` property. If a commit match multiple rules, the highest release type (`major` > `minor` > `patch`) is associated with the commit.
65
65
66
-
See [release types](lib/default/release-types.js) for the release types hierarchy.
66
+
See [release types](lib/default-release-types.js) for the release types hierarchy.
67
67
68
68
With the previous example:
69
69
* Commits with `type` 'docs' and `scope` 'README' will be associated with a `patch` release.
@@ -72,7 +72,7 @@ With the previous example:
72
72
73
73
#### Default rules matching
74
74
75
-
If a commit doesn't match any rule in `releaseRules` it will be evaluated against the [default release rules](lib/default/release-rules.js).
75
+
If a commit doesn't match any rule in `releaseRules` it will be evaluated against the [default release rules](lib/default-release-rules.js).
76
76
77
77
With the previous example:
78
78
* Commits with a breaking change will be associated with a `minor` release.
@@ -82,7 +82,7 @@ With the previous example:
82
82
83
83
#### No rules matching
84
84
85
-
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.
85
+
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.
86
86
87
87
With the previous example:
88
88
* Commits with `type` 'style' will not be associated with a release type.
@@ -120,10 +120,10 @@ For example with `eslint` preset:
120
120
With this configuration:
121
121
* Commits with `tag` 'Docs', that contains 'README' in their header message will be associated with a `patch` release.
122
122
* Commits with `tag` 'New' will be associated with a `patch` release.
123
-
* Commits with `tag` 'Breaking' will be associated with a `major` release (per [default release rules](lib/default/release-rules.js)).
124
-
* Commits with `tag` 'Fix' will be associated with a `patch` release (per [default release rules](lib/default/release-rules.js)).
125
-
* Commits with `tag` 'Update' will be associated with a `minor` release (per [default release rules](lib/default/release-rules.js)).
126
-
* Commits with `tag` 'New' will be associated with a `minor` release (per [default release rules](lib/default/release-rules.js)).
123
+
* Commits with `tag` 'Breaking' will be associated with a `major` release (per [default release rules](lib/default-release-rules.js)).
124
+
* Commits with `tag` 'Fix' will be associated with a `patch` release (per [default release rules](lib/default-release-rules.js)).
125
+
* Commits with `tag` 'Update' will be associated with a `minor` release (per [default release rules](lib/default-release-rules.js)).
126
+
* Commits with `tag` 'New' will be associated with a `minor` release (per [default release rules](lib/default-release-rules.js)).
127
127
* All other commits will not be associated with a release type.
0 commit comments