Git-bump assumes the current version of the Git-controlled project.

Git-bump is based on the Semantic Versioning 2.0.0.

See also https://semver.org/

npm install -g @rinse495/git-bump

Move the current directory to some Git-controlled project.

Then, type 'git bump' and you'll see an assumption of the current version.

$ git bump
1.0.0

It prints the exact version from Git tags, or a bumped version assumed by tags or commits.

Type git-bump --help to see help in the command line.

Giving an identifier to the --prerelease option, Git-bump adds a prerelease version to an assumed version core.

$ git bump --prerelease beta
1.0.0-beta.0

Note that it does nothing when the exact version exists.

$ git describe --exact-match
1.0.0
$ git bump --prerelease beta
1.0.0

Giving the --release option, Git-bump always shows a release version.

You want to use this when the latest tag indicates a prerelease version.

$ git bump
1.0.0-beta.1
$ git bump --release
1.0.0

Unlike --prerelease, a release version is newly suggested even when HEAD is tagged with a prerelease version.

$ git describe --exact-match
1.0.0-beta.0
$ git bump --release
1.0.0

Giving the --build option, Git-bump adds a build metadata to an assumed version.

$ git bump --build
1.0.0+6717d5d

Note that it does nothing when the exact version exists.

$ git describe --exact-match
1.0.0
$ git bump --build
1.0.0

Giving a version to the --initial-version option, Git-bump prints the version when no previous version found.

$ git tag
$ git bump --initial-version 1.0.0
1.0.0

The default value is 0.1.0.

$ git tag
$ git bump
0.1.0

Giving the --include-non-annotated option, Git-bump sees non-annotated tags as well, in search for the previous version.

$ git bump --include-non-annotated
1.0.0

Git-bump bumps a new version and prints it as a current version when new commits are stacked on the latest tag.

A version being increased is determined by prefixes of commit messages.

Each prefix is mapped to a scale of modification. Principal prefixes are the following:

If the biggest scale of modification found in the new commits is -

• A major modification, Git-bump increases a major version.
• A minor modification, Git-bump increases a minor version.
• A patch modification, Git-bump increases a patch version.

Note If the previous version is below 1.0.0, Git-bump increases a minor version even when major modifications are found.

Additionally, you can have preferred keywords on $HOME/.git-bump.json. You can also override a predefined keywords above.

Here is a sample .git-bump.json for those want to use the 'bug' keyword for a patch modification insteads of 'fix':

{
    "keywords": {
        "patch": [
            "bug"
        ],
        "minor": [
            "fix",
            "fixes",
            "fixed",
            "fixing"
        ],
        "major": [
            "major"
        ]
    }
}