Skip to content

Commit 270d752

Browse files
jy95JPeer264
authored andcommitted
Docs: add usage with semantic-release (#38)
* Docs : analyzeCommits and generateNotes options Write the provided solution (semantic-release/semantic-release#426 (comment)) inside the readme * Docs: fix wrong json Docs: fix wrong json * Docs : changes requested by owner Docs : changes requested by owner
1 parent b5c0ce8 commit 270d752

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

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

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

4170
> 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)