git-semver-info

This library is intended for define semantic version of package by the git environment. It's inspired by GitFlow, SemVer 2.0.0, GitVersion.

Base agreements:

• The stable versions of the package should be are announced by the developer in master branches
• Unstable versions of the package could be auto computed by the git environment on CI server
• Development should be carried out within the framework of the GitFlow, and package versions should be based on SemVer 2.0.0.

In order to CI server can publish the package as unstable (prerelease) and stable version. For definition to be performed correctly, it is necessary to observe GitFlow branching model.

This definition available for following branches:

• master - package version remains as is X.Y.Z
• develop - to package version is X.(Y+1).0-alpha.{commits}
• feature/* - to package version is X.(Y+1).0-feature-{hash}.{commits}
• release/vX'.Y'.Z' - to package version is X'.Y'.Z'-rc.{commits}
• hotfix/* - to package version is X.Y.(Z+1)-beta.{commits}

X - current major version declarate in package.json

Y - current minor version declarate in package.json

Z - current patch version declarate in package.json

{hash} - it's first feature branch commit (generic commit from develop and feature branch)

{commits} - quantity commits from branch start.

Prerelease path could be override with config file git-semver-info.json. This config file should be place into current work directory.

Config file content (default value):

{
  "prerelease": {
    "develop": "alpha.${developBranchCommitsCount}",
    "feature": "feature-${firstFeatureCommitSha}.${featureBranchCommitsCount}",
    "hotfix": "beta.${hotfixBranchCommitsCount}",
    "release": "rc.${releaseBranchCommitsCount}"
  }
}

Example

The final semantic version of the package looks like:

<major>.<minor>.<patch>-<prerelease>+<build-number>

For example for branch feature/feature-long-name and package main version 1.2.3, it's prerelease version looks like:

1.2.3-feature-3kn3erb.13+42

Install

$ npm i git-semver-info -g

Usage

In package directory (where placed file package.json) run:

$ git-semver-info --help

Output:

Usage: git-semver-info [options] [cwd]


Options:

  -v, --version   output the version number
  -j, --json      output as JSON
  -t, --teamcity  output for TeamCity as service message
  -w, --write     write version into package.json
  -h, --help      output usage information