Simple node module for git revision information
This module provides an simple API for both synchronous and asynchronous fetching of git revision information. Note: this module requires Node 0.12 for the execSync method
Returns the short form of a the current git hash
Example: f1079c1
Returns the short form of a the current git hash
Example: f1079c100a1889a3c75f8de650582bd5b936594c
Alias of long
Returns the current tag. If there is no tag, this will return the full hash (just as if you called long)
Example: f1079c100a1889a3c75f8de650582bd5b936594c or 0.0.1
Returns the current branch
Example: master
var gitRevision = require('git-revision')
// Get the current short git hash
// Synchronously
var shortHash = gitRevision("short")
// Asynchronously
gitRevision("short", function (hash) {
var hash = hash
})
// Get the current tag
// Synchronously
var tag = gitRevision("tag")
// Asynchronously
gitRevision("tag", function (tag) {
var tag = tag
})The MIT License
Copyright (c) 2016 Matthew Davies https://daviesgeek.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.