Conventional Recommended Workflow

Automatic CHANGELOG.md generation, using GitHub's new squash button and the workflow outlined in conventional-changelog-cli.

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 conventions.
3. when you're ready to release to npm:
4. checkout master.
5. run conventional-recommended-workflow.
6. git push --tags; git push origin master; npm publish.

conventional-recommended-workflow does the following:

1. bumps the version in package.json
2. runs conventional-changelog and updates 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:

conventional-recommended-workflow --first-release

Installation

npm i conventional-recommended-workflow

Automating

Add this to your package.json

{
  "scripts": {
    "release": "conventional-recommended-workflow"
  }
}

License

ISC