README.md

Standard Version

stop using npm version, use standard-version it rocks!

Automatic release and CHANGELOG management, using GitHub's new squash button and the workflow outlined in conventional-changelog-standard.

how it works:

1. when you land commits on your master branch, select the Squash and Merge option.
2. add a title and body that follows the conventional-changelog-standard conventions.
3. when you're ready to release to npm:
4. checkout master.
5. run standard-version.
6. git push --follow-tags origin master; npm publish.

standard-version does the following:

1. bumps the version in package.json (based on your commit history).
2. uses conventional-changelog to update CHANGELOG.md.
3. commits package.json and CHANGELOG.md.
4. tags a new release.

Initial CHANGELOG.md Generation

When you're generating your changelog for the first time, simply do:

standard-version --first-release

Installation

npm i standard-version -g

Or, add it as a development dependency like so:

npm i standard-version --save-dev

_And add this to your package.json:

{
  "scripts": {
    "release": "standard-version"
  }
}

Commit Message Convention, at a Glance

patches:

git commit -a -m "fix(parsing): fixed a bug in our parser"

features:

git commit -a -m "feat(parser): we now have a parser \o/"

breaking changes:

git commit -a -m "feat(new-parser): introduces a new parsing library
BREAKING CHANGE: new library does not support foo-construct"

other changes:

You decide, e.g., docs, chore, etc.

git commit -a -m "docs: fixed up the docs a bit"

but wait, there's more!

Github usernames (@bcoe) and issue references (#133) will be swapped out for the appropriate URLs in your CHANGELOG.

Badges!

Tell your users that you adhere to the standard-version commit guidelines:

[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)

License

ISC