head-hash
Get the current commit hash
Why?
- Useful hash for cache busting.
- Can be used as a build version.
- Identify code without leaking secrets.
Install
npm install head-hash --save
Usage
Get it into your program.
const headHash = require('head-hash');
Get the hash of the current HEAD.
headHash().then((hash) => {
console.log('hash:', hash);
});
API
headHash(option)
Returns a Promise
for the hash of the latest commit on the HEAD branch.
option
Type: object
cwd
Type: string
Default: process.cwd()
The directory who's HEAD you want to use for finding the latest commit.
short
Type: boolean
Default: false
Whether to shorten the hash to the shortest possible unique name of at least 7 characters.
Related
- branch-name - Get the current branch name
- build-version - Get a version for your build
Contributing
See our contributing guidelines for more details.
- Fork it.
- Make a feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request.
License
Go make something, dang it.