Skip to content

Commit 8d1e171

Browse files
trescenzipvdlg
authored andcommitted
chore(docs): correct links to default rules
1 parent d834cab commit 8d1e171

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Customizable commit-analyzer plugin for [semantic-release](https://github.com/se
88

99
## Options
1010

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.
1212

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

@@ -41,7 +41,7 @@ Additional options can be set within the plugin definition in `package.json` to
4141

4242
### Release Rules
4343

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.
4545

4646
#### Rules definition
4747
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
6363

6464
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.
6565

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.
6767

6868
With the previous example:
6969
* Commits with `type` 'docs' and `scope` 'README' will be associated with a `patch` release.
@@ -72,7 +72,7 @@ With the previous example:
7272

7373
#### Default rules matching
7474

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).
7676

7777
With the previous example:
7878
* Commits with a breaking change will be associated with a `minor` release.
@@ -82,7 +82,7 @@ With the previous example:
8282

8383
#### No rules matching
8484

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.
8686

8787
With the previous example:
8888
* Commits with `type` 'style' will not be associated with a release type.
@@ -120,10 +120,10 @@ For example with `eslint` preset:
120120
With this configuration:
121121
* Commits with `tag` 'Docs', that contains 'README' in their header message will be associated with a `patch` release.
122122
* 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)).
127127
* All other commits will not be associated with a release type.
128128

129129
#### External package / file

0 commit comments

Comments
 (0)