gh-latest-release

A Node module to get the latest published full release for the Github repository.

const ghLatestRelease = require('gh-latest-release');

ghLatestRelease('strongloop/fsevents', release => console.log(release));

{
  url: 'https://api.github.com/repos/strongloop/fsevents/releases/2265953',
  assets_url: 'https://api.github.com/repos/strongloop/fsevents/releases/2265953/assets',
  upload_url: 'https://uploads.github.com/repos/strongloop/fsevents/releases/2265953/assets{?name,label}',
  html_url: 'https://github.com/strongloop/fsevents/releases/tag/v1.0.6',
  id: 2265953,
  tag_name: 'v1.0.6',
  target_commitish: 'master',
  name: '',
  draft: false,
  author: {
    login: 'es128',
    id: 1740641,
    avatar_url: 'https://avatars.githubusercontent.com/u/1740641?v=3',
    gravatar_id: '',
    url: 'https://api.github.com/users/es128',
    html_url: 'https://github.com/es128',
    followers_url: 'https://api.github.com/users/es128/followers',
    following_url: 'https://api.github.com/users/es128/following{/other_user}',
    gists_url: 'https://api.github.com/users/es128/gists{/gist_id}',
    starred_url: 'https://api.github.com/users/es128/starred{/owner}{/repo}',
    subscriptions_url: 'https://api.github.com/users/es128/subscriptions',
    organizations_url: 'https://api.github.com/users/es128/orgs',
    repos_url: 'https://api.github.com/users/es128/repos',
    events_url: 'https://api.github.com/users/es128/events{/privacy}',
    received_events_url: 'https://api.github.com/users/es128/received_events',
    type: 'User',
    site_admin: false
  },
  prerelease: false,
  created_at: '2015-12-10T14:01:28Z',
  published_at: '2015-12-10T14:04:19Z',
  assets: [],
  tarball_url: 'https://api.github.com/repos/strongloop/fsevents/tarball/v1.0.6',
  zipball_url: 'https://api.github.com/repos/strongloop/fsevents/zipball/v1.0.6',
  body: 'Updated node-pre-gyp to 0.6.17'
}

Installation

Use npm.

npm install gh-latest-release

API

const ghLatestRelease = require('gh-latest-release');

ghLatestRelease(ownerRepo [, options])

ownerRepo: String (/-separated owner and repository names, for example https://github.com/es128/ssl-utils → 'es128/ssl-utils')
options: Object (gh-get options)
Return: Promise instance

It makes an API request to get the latest release information, and returns a promise. The promise will be fulfilled with a JSON object if successful, otherwise rejected with an error.

License

Copyright (c) 2016 Shinnosuke Watanabe

Licensed under the MIT License.