Get the most recent git tag of your repository using git-describe(1)

Install

1$ npm install --save git-latest-tag

Usage

Use a callback

1var getLatestTag = require('git-latest-tag');
2var options = {
3  all: 'ok',
4  contains: true,
5  candidates: 10,
6  'commit-ish': 'HEAD'
7};
8
9getLatestTag(options, function(err, tag) {
10  console.log(tag);
11  //=> latestTag
12});

Use as a readable stream

1var getLatestTag = require('git-latest-tag');
2var options = {
3  all: 'ok',
4  contains: true,
5  candidates: 10,
6  'commit-ish': 'HEAD'
7};
8
9getLatestTag(options)
10  .pipe(...);

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