Skip to content

Commit 87deefd

Browse files
authored
Docs : analyzeCommits and generateNotes options
Write the provided solution (semantic-release/semantic-release#426 (comment)) inside the readme
1 parent b5c0ce8 commit 87deefd

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,32 @@ or if you already have an alias for sgc, use following instead:
3636
$ semantic-git-commit
3737
```
3838

39+
### Configure sgc for the following semantic-release options : analyzeCommits and generateNotes
40+
41+
First step, install the following plugins with
42+
```sh
43+
$ npm install --save-dev sr-commit-analyzer sr-release-notes-generator conventional-changelog-eslint
44+
```
45+
or
46+
```sh
47+
$ yarn add -D sr-commit-analyzer sr-release-notes-generator conventional-changelog-eslint
48+
```
49+
50+
Then, add this in your package.json :
51+
```json
52+
{
53+
"release": {
54+
"analyzeCommits": {
55+
"path": "sr-commit-analyzer",
56+
"preset": "eslint"
57+
},
58+
"generateNotes": {
59+
"path": "sr-release-notes-generator",
60+
"preset": "eslint"
61+
}
62+
}
63+
```
64+
3965
## Config
4066

4167
> Just create a `.sgcrc` in your project root or you can add everything in your `package.json` with the value `sgc`

0 commit comments

Comments
 (0)