README

node-github-diff

Github diffs with Node style 😎

A script to check the diffs between project versions.

Usage

const nodeGithubDiff = require('node-github-diff');

// Using promises
nodeGithubDiff({
  repository: 'willmendesneto/generator-update-yeoman-test',
  base: 'v0.0.3',
  head: 'v0.0.5',
})
.then((gitPatches) => console.log(gitPatches));

// using async/await
const gitPatches = await nodeGithubDiff({
  repository: 'willmendesneto/generator-update-yeoman-test',
  base: 'v0.0.3',
  head: 'v0.0.5',
});

console.log(gitPatches);

Setup

Private repositories

In order to use node-github-diff in private repositories you'll need to create a personal access token which has permissions to read private repositories:

Token permissions

Then, you can pass the github token information in the options object, using the token key.

const nodeGithubDiff = require('node-github-diff');
...
nodeGithubDiff({
  repository: 'willmendesneto/generator-update-yeoman-test',
  base: 'v0.0.3',
  head: 'v0.0.5',
  token: 'your-github-token',
});
...

Run node-github-diff

Make sure you have npm@>=5.2.0:

npm install -g npm@latest

This package is using async/await feature, so please make sure you are using node@>=v7.6.0 which supports this feature by default based on Node.green website. In case you can't please make sure you're running the code with --harmony-async-await flag or using solving in your code.

Parameters

repository: Github repository to be checked;
base: Package version to use as a starting point to check the diff;
head: Package version to use as a final point to check the diff;
token: github token to be used in case of private repositories;

Author

Wilson Mendes (willmendesneto)

Usage no npm install needed!