Get last successful GitHub commit

last-successful-gh-commit

To achieve something similar to GIT_PREVIOUS_SUCCESSFUL_COMMIT env var defined by Git Plugin on Jenkins.

Table of Contents

• Install
• Example
• Usage
• Contribute
• License

Install

Node.js v6.5 or newer is required.

Via the yarn client:

$ yarn add --dev last-successful-gh-commit

Via the npm client:

$ npm install --save-dev last-successful-gh-commit

Example

import getLastSuccessfulGHCommit from 'last-successful-gh-commit';

const owner = 'ramasilveyra';
const name = 'last-successful-gh-commit';
const token = process.env.GH_TOKEN;

getLastSuccessfulGHCommit({ owner, name, token })
  .then(commit => {
    console.log('Last successful commit: ', commit);
  })
  .catch(err => {
    console.error('No successful commit found', err);
  });

Usage

getLastSuccessfulGHCommit(options)

options

Type: Object
Required

options.owner

Type: string
Required

Owner of the repository.

options.name

Type: string
Required

Name of the repository.

options.token

Type: string
Required

GitHub token with repo scope.

Contribute

Feel free to dive in! Open an issue or submit PRs.

last-successful-gh-commit follows the Contributor Covenant Code of Conduct.

License

MIT