head-hash

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)

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.

Contributing

See our contributing guidelines for more details.

1. Fork it.
2. Make a feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request.

License

MPL-2.0 © Seth Holladay

Go make something, dang it.