npm version major|minor|patch
To install invoke:
npm install -g npm-bump
You now have the
npm-bump binary available.
If you want to use it as a module, invoke:
npm install npm-bump --save
The aim of this module is to keep a repository in a state where if the
version value in
package.json points to a stable version, it's a tagged commit that was published to npm. Since one can add Git endpoints as packages' "versions", this allows to quickly check if an installed dependency uses a pre-release or a stable version.
Once the package has been installed, it may be used from the terminal:
releaseType is one of:
To use as a module, do the following:
var npmBump = require('npm-bump'); npmBump(releaseType);
You can check the version of
Regardless of using the package as a binary or a module, invoking the above code will result in:
- Creating a new commit that increases the project version to the nearest stable one having a larger
- Tagging the commit with a specified version.
- Creating a new commit with an increased patch version and the
- Asking the user to do a final check and proceed or rollback.
If the user goes along, the new version gets published and created commits and tags pushed to the
origin remote. Otherwise, all the changes are reversed.
Until the user gives the final green light, everything happens locally and is fully reversible.
If you supply
releaseType other than
patch, it will be treated as a pre-release identifier and a proper pre-release version will be tagged & published. Such a version will be published with an npm tag equal to the identifier. For example, if your package is currently at version
1.0.0-pre, the following command:
will publish a version
1.0.0-beta.0 under the tag
beta and bump the version to
You can optionally pass the remote name and the branch name to be used, in addition to a prefix/suffix to be applied to version bump commit message. By default the remote is assumed to be
origin and the branch:
master. To customize, do the following:
- When using from shell:
npm-bump releaseType -r remoteName -b branch -p issue-prefix
- When using as a library:
var npmBump = require('npm-bump').custom(remoteName, branch); npmBump(releaseType);
Supported Node.js versions
This project aims to support all Node.js versions supported upstream with the exception of those in maintenance mode (see Release README for more details).
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using
Copyright (c) 2014 Michał Gołębiowski-Owczarek. Licensed under the MIT license.