Skip to content

Docs : analyzeCommits and generateNotes options #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 30, 2017
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,33 @@ or if you already have an alias for sgc, use following instead:
$ semantic-git-commit
```

### Configure sgc for the following semantic-release options : analyzeCommits and generateNotes
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you change this to:

### usage with semantic-release

> Configure sgc for the following semantic-release options: `analyzeCommits` and `generateNotes`


First step, install the following plugins with
```sh
$ npm install --save-dev sr-commit-analyzer sr-release-notes-generator conventional-changelog-eslint
```
or
```sh
$ yarn add -D sr-commit-analyzer sr-release-notes-generator conventional-changelog-eslint
```

Then, add this in your package.json :
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: Can you highlight the package.json?

`package.json`

```json
{
"release": {
"analyzeCommits": {
"path": "sr-commit-analyzer",
"preset": "eslint"
},
"generateNotes": {
"path": "sr-release-notes-generator",
"preset": "eslint"
}
}
}
```

## Config

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