Get the most recent git tag of your repository using git-describe(1)
Install
$ npm install --save git-latest-tag
Usage
Use a callback
var getLatestTag = ;var options = all: 'ok' contains: true candidates: 10 'commit-ish': 'HEAD'; ;
Use as a readable stream
var getLatestTag = ;var options = all: 'ok' contains: true candidates: 10 'commit-ish': 'HEAD'; ;
API
getLatestTag([options], callback)
Returns a readable stream.
Options
Type: object
or boolean
Options will be dash-cased for you.
Please check the available options at http://git-scm.com/docs/git-describe.
NOTE: if a flag takes no value and the passed options.value
is truthy, it will generate the flag only without any value. If it's falsy the flag will not be included.
If it's a true
, it will suppress long format, only showing the closest tag in refs/tags namespace and will return an empty string if there is no tags but more than one commit (same as { tags: true, abbrev: 0 }
).
callback(err, tag)
License
MIT © Steve Mao