Skip to content

Commit 4cf763e

Browse files
committed
docs: fix example regarding the breaking change plural
1 parent b888c2c commit 4cf763e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The plugin can be configured in the [**semantic-release** configuration file](ht
3535
{"type": "style", "release": "patch"}
3636
],
3737
"parserOpts": {
38-
"noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
38+
"noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
3939
}
4040
}],
4141
"@semantic-release/release-notes-generator"
@@ -44,7 +44,7 @@ The plugin can be configured in the [**semantic-release** configuration file](ht
4444
```
4545

4646
With this example:
47-
- the commits that contains `BREAKING CHANGE`, `BREAKING CHANGES` or `BREAKING` in their body will be considered breaking changes (by default the [angular preset](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/index.js#L14) checks only for `BREAKING CHANGE` and `BREAKING CHANGES`)
47+
- the commits that contains `BREAKING CHANGE` or `BREAKING CHANGES` in their body will be considered breaking changes (by default the [angular preset](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/index.js#L14) checks only for `BREAKING CHANGE`)
4848
- the commits with a 'docs' `type`, a 'README' `scope` will be associated with a `patch` release
4949
- the commits with a 'refactor' `type` will be associated with a `patch` release
5050
- the commits with a 'style' `type` will be associated with a `patch` release

0 commit comments

Comments
 (0)