Package detail

online-branch-exist

tunnckoCore363MIT2.0.2

Check that given branch/tag/release exist in github repo, using user/repo#branch pattern.

api, apis, async, branch

readme

npm mit license build status coverage status deps status

Check that given branch/tag/release exist in github repo, using user/repo#branch pattern.

Install

npm i --save online-branch-exist
npm test

API

For more use-cases see the tests

onlineExist

using user/repo#branch you can check if tag or branch exists

  • pattern {String}
  • opts {Object} options to pass to got
  • callback {Function}

Example:

var onlineExist = require('online-branch-exist');

// first will check if branch exists
// if not exist, will check if tag with name `master` exists
// at last if not exist will return `false`
onlineExist('tunnckoCore/koa-better-body#master', function(err, res) {
  console.log(err);
  //=> always null
  console.log(res);
  //=> true
})

.branch

Checks that given branch exists in github repo, using user/repo#branch string pattern
Actually same as above.

  • pattern {String}
  • opts {Object} options to pass to got
  • callback {Function}

Example:

var onlineExist = require('online-branch-exist');

onlineExist.branch('koajs/koa#proxy', function(err, res) {
  console.log(err);
  //=> always null
  console.log(res);
  //=> true
})

.tag

Checks that given tag exists in github repo, using user/repo#tag string pattern

  • pattern {String}
  • opts {Object} options to pass to got
  • callback {Function}

Example:

var onlineExist = require('online-branch-exist');

onlineExist.tag('hybridables/handle-arguments#v2.0.0', function(err, res) {
  console.log(err);
  //=> always null
  console.log(res);
  //=> true
})

Related

  • is-missing: Check that given name or user/repo exists in npm registry or in github as organization/user repository.
  • github-generate-token: Generating Github Personal Access Token using Basic Auth username:password
  • gitclone: Clone a Github repository with only username/repo.
  • assertit: Thin sugar layer on top of testit framework, is-kindof and assert.
  • jstransformer: Normalize the API of any jstransformer

Author

Charlike Mike Reagent

License MIT license

Copyright (c) 2014-2015 Charlike Mike Reagent, contributors.
Released under the MIT license.


Proudly generated by docks(1), April 5, 2015

changelog

v2.0.2 / April 5, 2015

  • Release v2.0.2 / npm@v2.0.2
  • move to assertit
  • run npm-related(1)

v2.0.1 / April 5, 2015

  • Release v2.0.1 / npm@v2.0.1
  • remove coveralls.yml

v2.0.0 / April 5, 2015

  • Release v2.0.0 / npm@v2.0.0
  • update logic, readme
  • add one more test
  • add related section
  • run docks(1)
  • refactor - breaking change: give opts.token instead just token as second argument

v1.2.0 / February 27, 2015

  • Release v1.2.0 / npm@v1.2.0
  • minimize travis builds, cuz the rate limiting
  • run update docs
  • update test coverage
  • fix readme typos
  • liberate jshint/jscs
  • fix description in package.json
  • run update readme
  • update tests to use the hack
  • remove uneccessary tests
  • hack for token logic in tests/travis
  • add token requirement

v1.1.0 / February 27, 2015

  • Release v1.1.0 / npm@v1.1.0
  • bump deps
  • add new tests
  • little relogic, review #3767d4

v1.0.1 / January 30, 2015

  • Release v1.0.1 / npm@v1.0.1
  • update readme docs

v1.0.0 / January 30, 2015

  • Release v1.0.0 / npm@v1.0.0
  • fix deps version ranges
  • add keywords
  • add tests
  • add .tag and .branch methods

v0.0.0 / January 30, 2015

  • npm@v0.0.0
  • first commits