Nascent Personality Manifestation

npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

releaseify

1.0.3 • Public • Published

releaseify Build Status

Get a project's current git commit/tag via Node and Browserify

Install

$ npm install --save releaseify

Usage

var release = require('releaseify')
 
release(function (err, data) {
  //=> null, {commit, tag}  
})
$ browserify entry.js -t releasify/transform

In Node, the git data will be read at run time. When the transform is applied via Browserify, the data is statically inserted into the bundle.

The Browserify transform works by statically analyzing your code and transforming releasify calls with inline shims. Static analysis is fragile and you'll want to write your code so that static analysis can detect your function calls.

Good

var releaseify = require('releaseify')
 
releasify(function (err, data) {
  // => ...  
})

Bad

var releaseify = require('releaseify')
 
releaseify.bind(null).call(console.log.bind(console))

API

release([options], callback) -> undefined

options

Type: object
Default: {}

Options that will be passed directly to child_process.

callback

Required
Type: function
Arguments: err, release

A function that receives an error (from git) or release data ({commit, tag}).

License

MIT © Ben Drucker

install

npm i releaseify

Downloadsweekly downloads

30

version

1.0.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability