Permalink
Browse files

Update doc for 'npm version'

  • Loading branch information...
isaacs committed Jul 12, 2012
1 parent 3072804 commit eba69b51faa6371e4e4118ba667346992018086a
Showing with 14 additions and 5 deletions.
  1. +14 −5 doc/cli/version.md
View
@@ -3,22 +3,31 @@ npm-version(1) -- Bump a package version
## SYNOPSIS
- npm version <newversion> [--message commit-message]
+ npm version [<newversion> | major | minor | patch | build]
## DESCRIPTION
Run this in a package directory to bump the version and write the new
data back to the package.json file.
The `newversion` argument should be a valid semver string, *or* a valid
-second argument to semver.inc (one of "patch", "minor", or "major"). In
-the second case, the existing version will be incremented by that amount.
+second argument to semver.inc (one of "build", "patch", "minor", or
+"major"). In the second case, the existing version will be incremented
+by 1 in the specified field.
If run in a git repo, it will also create a version commit and tag, and
fail if the repo is not clean.
-If supplied with `--message` (shorthand: `-m`) command line option, npm
-will use it as a commit message when creating a version commit.
+If supplied with `--message` (shorthand: `-m`) config option, npm will
+use it as a commit message when creating a version commit. If the
+`message` config contains `%s` then that will be replaced with the
+resulting version number. For example:
+
+ npm version patch -m "Upgrade to %s for reasons"
+
+If the `sign-git-tag` config is set, then the tag will be signed using
+the `-s` flag to git. Note that you must have a default GPG key set up
+in your git config for this to work properly.
## SEE ALSO

0 comments on commit eba69b5

Please sign in to comment.