head-hash

WebJar for head-hash

License	MPL-2.0
GroupId	org.webjars.npm
ArtifactId	head-hash
Last Version	0.2.3
Release Date	Apr 26, 2018
Type	jar
Description	head-hash WebJar for head-hash
Project URL	http://webjars.org
Source Code Management	https://github.com/sholladay/head-hash

Download head-hash

Filename	Size
head-hash-0.2.3.pom
head-hash-0.2.3.jar	9 KB
head-hash-0.2.3-sources.jar	22 bytes
head-hash-0.2.3-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/head-hash/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>head-hash</artifactId>
    <version>0.2.3</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/head-hash/
implementation 'org.webjars.npm:head-hash:0.2.3'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/head-hash/
implementation ("org.webjars.npm:head-hash:0.2.3")

Apache Buildr

'org.webjars.npm:head-hash:jar:0.2.3'

Apache Ivy

<dependency org="org.webjars.npm" name="head-hash" rev="0.2.3">
  <artifact name="head-hash" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='head-hash', version='0.2.3')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "head-hash" % "0.2.3"

Leiningen

[org.webjars.npm/head-hash "0.2.3"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

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.

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.

Versions

Version
0.2.3 Apr 26, 2018