shelljs-changelog

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.

Changelog

v0.2.6 (2022-01-08)

Full Changelog

Implemented enhancements:

• Exit with non-zero status if the job fails #3

Fixed bugs:

• Method RegExp.prototype.test called on incompatible receiver undefined #5
• Exit with non-zero status if the job fails #3
• Error: Make a POST first. #1
• fix: command can now create initial CHANGELOG #7 (nfischer)
• refactor: use shelljs-plugin-sleep #6 (nfischer)

Closed issues:

• Command line options #8
• Better sleep command #2

Merged pull requests:

• chore: update deps #9 (nfischer)
• fix: verify the changelog before it is commited #4 (freitagbr)