Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thlorenz/resolve-github-refs

Resolves all refs for a remote github repo, including heads, tags and pulls.
https://github.com/thlorenz/resolve-github-refs

Last synced: 26 days ago
JSON representation

Resolves all refs for a remote github repo, including heads, tags and pulls.

Awesome Lists containing this project

README

        

# resolve-github-refs [![build status](https://secure.travis-ci.org/thlorenz/resolve-github-refs.png)](http://travis-ci.org/thlorenz/resolve-github-refs)

Resolves all refs for a remote github repo, including heads, tags and pulls.

```js
var resolve = require('resolve-github-refs')

resolve('joyent/node', function (err, refs) {
if (err) return console.error(err);
console.log('The nodejs repo has %d heads, %d tags and %d pulls', refs.heads.length, refs.tags.length, refs.pulls.length);
console.log('The latest head is "%s"', refs.heads.pop());
console.log('The latest tag is "%s"', refs.tags.pop());
console.log('The latest pull is "%s"', refs.pulls.pop());
})
```

```
The nodejs repo has 104 heads, 231 tags and 5257 pulls
The latest head is "v0.11.12-release"
The latest tag is "works"
The latest pull is "7394/merge
```

## Installation

npm install resolve-github-refs

## API









resolveGithubRefs(repo, cb)




Parameters:

Name
Type
Description

repo

string

github repository of the form user/name

cb

function

called back with error or all github refs (including heads, tags and pulls)


Source:




*generated with [docme](https://github.com/thlorenz/docme)*

## License

MIT