git-tags-remote

git-tags-remote

Get remote repository tags and parse them.

Inspired by remote-git-tags and node-git-tags. The only reason this exists is to allow access to any type of remote repository, including repositories accessed through SSH, or private repositories. If git ls-remote --tags works for you, so will this.

Install

$ npm install --save git-tags-remote

Note that a git binary and command line interface is a prerequisite.

Usage

const gitTagsRemote = require('git-tags-remote');

gitTagsRemote.get('git@github.com:sh0ji/focus-rover.git')
    .then(tags => console.log(tags));
// => Map {'v1.0.0-rc.2' => '8e048a0fd9cb668366eef550be445ac761efd667', ...}

API

• .get(gitUrl)
  Returns a Promise<Map> with the Git tags as keys and their commit SHA as values, just like remote-git-tags.

  • gitUrl must be a valid git url.
    e.g. 'https://github.com/sh0ji/git-tags-remote.git' is valid but 'github.com/sh0ji/git-tags-remote' is not.

• .latest(gitUrl)
  Returns an Array with the latest git tag and commit SHA value.
  e.g. ['v1.0.0-rc.2', '8e048a0fd9cb668366eef550be445ac761efd667']