2015-05-01 16:27:33 +08:00
|
|
|
.TH "NPM\-VERSION" "1" "May 2015" "" ""
|
2011-11-27 01:21:03 +08:00
|
|
|
.SH "NAME"
|
2014-09-25 05:41:07 +08:00
|
|
|
\fBnpm-version\fR \- Bump a package version
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.P
|
|
|
|
|
.RS 2
|
2014-11-05 07:08:12 +08:00
|
|
|
.nf
|
2014-09-17 06:38:50 +08:00
|
|
|
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease]
|
2014-11-05 07:08:12 +08:00
|
|
|
.fi
|
2014-09-25 05:41:07 +08:00
|
|
|
.RE
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.P
|
2011-11-27 01:21:03 +08:00
|
|
|
Run this in a package directory to bump the version and write the new
|
2015-01-09 06:37:26 +08:00
|
|
|
data back to \fBpackage\.json\fR and, if present, \fBnpm\-shrinkwrap\.json\fR\|\.
|
2011-11-27 01:21:03 +08:00
|
|
|
.P
|
2014-09-17 06:38:50 +08:00
|
|
|
The \fBnewversion\fR argument should be a valid semver string, \fIor\fR a
|
|
|
|
|
valid second argument to semver\.inc (one of "patch", "minor", "major",
|
|
|
|
|
"prepatch", "preminor", "premajor", "prerelease")\. In the second case,
|
|
|
|
|
the existing version will be incremented by 1 in the specified field\.
|
2011-11-27 01:21:03 +08:00
|
|
|
.P
|
2015-03-06 16:57:32 +08:00
|
|
|
If run in a git repo, it will also create a version commit and tag, and fail if
|
|
|
|
|
the repo is not clean\. This behavior is controlled by \fBgit\-tag\-version\fR (see
|
|
|
|
|
below), and can be disabled on the command line by running \fBnpm
|
|
|
|
|
\-\-no\-git\-tag\-version version\fR
|
2011-11-27 01:21:03 +08:00
|
|
|
.P
|
2012-07-14 02:40:38 +08:00
|
|
|
If supplied with \fB\-\-message\fR (shorthand: \fB\-m\fR) config option, npm will
|
2014-09-25 05:41:07 +08:00
|
|
|
use it as a commit message when creating a version commit\. If the
|
|
|
|
|
\fBmessage\fR config contains \fB%s\fR then that will be replaced with the
|
2012-07-14 02:40:38 +08:00
|
|
|
resulting version number\. For example:
|
2014-09-25 05:41:07 +08:00
|
|
|
.P
|
|
|
|
|
.RS 2
|
2014-11-05 07:08:12 +08:00
|
|
|
.nf
|
2012-07-14 02:40:38 +08:00
|
|
|
npm version patch \-m "Upgrade to %s for reasons"
|
2014-11-05 07:08:12 +08:00
|
|
|
.fi
|
2014-09-25 05:41:07 +08:00
|
|
|
.RE
|
2012-07-14 02:40:38 +08:00
|
|
|
.P
|
|
|
|
|
If the \fBsign\-git\-tag\fR config is set, then the tag will be signed using
|
|
|
|
|
the \fB\-s\fR flag to git\. Note that you must have a default GPG key set up
|
2013-02-16 02:49:16 +08:00
|
|
|
in your git config for this to work properly\. For example:
|
2014-09-25 05:41:07 +08:00
|
|
|
.P
|
|
|
|
|
.RS 2
|
2014-11-05 07:08:12 +08:00
|
|
|
.nf
|
2013-02-16 02:49:16 +08:00
|
|
|
$ npm config set sign\-git\-tag true
|
|
|
|
|
$ npm version patch
|
2014-09-25 05:41:07 +08:00
|
|
|
|
2013-02-16 02:49:16 +08:00
|
|
|
You need a passphrase to unlock the secret key for
|
|
|
|
|
user: "isaacs (http://blog\.izs\.me/) <i@izs\.me>"
|
|
|
|
|
2048\-bit RSA key, ID 6C481CF6, created 2010\-08\-31
|
2014-09-25 05:41:07 +08:00
|
|
|
|
2013-02-16 02:49:16 +08:00
|
|
|
Enter passphrase:
|
2014-11-05 07:08:12 +08:00
|
|
|
.fi
|
2014-09-25 05:41:07 +08:00
|
|
|
.RE
|
2015-03-06 16:57:32 +08:00
|
|
|
.SH CONFIGURATION
|
|
|
|
|
.SS git\-tag\-version
|
|
|
|
|
.RS 0
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
Default: true
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
Type: Boolean
|
|
|
|
|
|
|
|
|
|
.RE
|
|
|
|
|
.P
|
|
|
|
|
Commit and tag the version change\.
|
2014-09-25 05:41:07 +08:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.RS 0
|
|
|
|
|
.IP \(bu 2
|
2011-11-27 01:21:03 +08:00
|
|
|
npm help init
|
2014-09-25 05:41:07 +08:00
|
|
|
.IP \(bu 2
|
2014-09-17 06:38:50 +08:00
|
|
|
npm help 5 package\.json
|
2014-09-25 05:41:07 +08:00
|
|
|
.IP \(bu 2
|
2014-09-17 06:38:50 +08:00
|
|
|
npm help 7 semver
|
2015-03-06 16:57:32 +08:00
|
|
|
.IP \(bu 2
|
|
|
|
|
npm help 7 config
|
2014-09-25 05:41:07 +08:00
|
|
|
|
|
|
|
|
.RE
|
2011-11-27 01:21:03 +08:00
|
|
|
|
