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

Docs : analyzeCommits and generateNotes options #38

merged 3 commits into from
Aug 30, 2017

Conversation

jy95
Copy link
Contributor

@jy95 jy95 commented Aug 30, 2017

Write the provided solution (semantic-release/semantic-release#426 (comment)) inside the readme

@coveralls
Copy link

coveralls commented Aug 30, 2017

Coverage Status

Coverage remained the same at 100.0% when pulling 87deefd on jy95:patch-1 into b5c0ce8 on JPeer264:master.

Docs: fix wrong json
@coveralls
Copy link

coveralls commented Aug 30, 2017

Coverage Status

Coverage remained the same at 100.0% when pulling 62c57d1 on jy95:patch-1 into b5c0ce8 on JPeer264:master.

README.md Outdated
$ 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`

README.md Outdated
@@ -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`

Docs : changes requested by owner
Copy link
Owner

@JPeer264 JPeer264 left a comment

Choose a reason for hiding this comment

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

LGTM

@coveralls
Copy link

coveralls commented Aug 30, 2017

Coverage Status

Coverage remained the same at 100.0% when pulling 3721596 on jy95:patch-1 into b5c0ce8 on JPeer264:master.

@JPeer264 JPeer264 merged commit 270d752 into JPeer264:master Aug 30, 2017
@JPeer264
Copy link
Owner

Thanks a lot @jy95 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants