nerdbank-gitversioning
v3.6.146
Published
Stamps your NPM packages with semver 2.0 compliant git commit specific version information.
Downloads
22,245
Readme
nerdbank-gitversioning
With this package, and a version.json file to express your version number checked into the root of your git repo:
{
"version": "1.0-beta"
}
Your NPM packages and other builds can be automatically stamped with a version that precisely describes the git commit that built it.
CLI use
Stamp your package.json file with the git-based version:
nbgv-setversion
Reset your package.json file with a version placeholder (suitable for checking in):
nbgv-setversion --reset
Or invoke the nbgv
tool directly for many options:
nbgv -?
Pack script
A possible script to pack your NPM package:
yarn nbgv-setversion
yarn pack
yarn nbgv-setversion --reset
Programmatic consumption
import * as nbgv from 'nerdbank-gitversioning'
// Retrieve all sorts of version information. Print just one bit.
const versionInfo = await nbgv.getVersion();
console.log(versionInfo.npmPackageVersion);
// Stamp the package.json file in the current directory with the computed version.
await nbgv.setPackageVersion();
// After packing, reset your package.json file to using a placeholder version number.
await nbgv.resetPackageVersionPlaceholder();
See our project README for more information.