package-diff-summary.js

compare package.json files to create CHANGELOG.md entries

Installation

npm install --global package-diff-summary

OR

yarn global add package-diff-summary

Usage

Usage
  $ package-diff-summary <revision>

Options
  -h, --help
  -v, --version

Output is intended to be copy-paste compatible with "Keep a CHANGELOG"

Example

For this very project, these commands:

git checkout 1.1.0
package-diff-summary 1.0.0

outputs this Markdown / CommonMark text:

- depend upon [github-url-from-git](https://www.npmjs.com/package/github-url-from-git) ^[1.5.0](https://github.com/visionmedia/node-github-url-from-git/blob/master/CHANGELOG.md)

- depend upon [package-engines-notifier](https://www.npmjs.com/package/package-engines-notifier) ^[1.1.0](https://github.com/jokeyrhyme/package-engines-notifier.js/releases/tag/1.1.0)

- depend upon [read-pkg-up](https://www.npmjs.com/package/read-pkg-up) ^2.0.0

which looks like:

• depend upon github-url-from-git ^1.5.0

• depend upon package-engines-notifier ^1.1.0

• depend upon read-pkg-up ^2.0.0

Configuration

GITHUB_OAUTH_TOKEN

Generate a new GitHub Personal Access Token without any special permissions, and set this as the value for the GITHUB_OAUTH_TOKEN environment variable.

This will reduce the likelihood of rate-limiting by GitHub's API, which will in turn increase the accuracy of the hyperlinks discovered.

See Also

• dependency-diff

• execa

• Keep a CHANGELOG

• github

• github-url-from-git

• got

• read-pkg-up

• semver