Changelog.js

A simple NodeJS script to create & update a CHANGELOG.md

Installation and setup

npm install --save-dev shelljs-changelog

Now, add a script to package.json like so:

  "scripts": {
    "test": "... whatever you had here before ...",
    "changelog": "shelljs-changelog"
  },

Dependencies

You'll need to have curl installed in order to use this script.

Also, make sure you have internet access when running this.

Usage example

To update the changelog, run:

npm run changelog

For best results, try to run this after every time you publish.

Command line options

--force

By default, this script verifies that the changelog diff contains no more than 5 deletions. With --force enabled, this step is skipped.