diff options
Diffstat (limited to 'deps/npm/html/partial/doc/cli/npm-version.html')
| -rw-r--r-- | deps/npm/html/partial/doc/cli/npm-version.html | 42 |
1 files changed, 32 insertions, 10 deletions
diff --git a/deps/npm/html/partial/doc/cli/npm-version.html b/deps/npm/html/partial/doc/cli/npm-version.html index ba4ac5a7b0..1beda3d288 100644 --- a/deps/npm/html/partial/doc/cli/npm-version.html +++ b/deps/npm/html/partial/doc/cli/npm-version.html @@ -8,10 +8,11 @@ data back to <code>package.json</code> and, if present, <code>npm-shrinkwrap.jso valid second argument to semver.inc (one of <code>patch</code>, <code>minor</code>, <code>major</code>, <code>prepatch</code>, <code>preminor</code>, <code>premajor</code>, <code>prerelease</code>). In the second case, the existing version will be incremented by 1 in the specified field.</p> -<p>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 <code>git-tag-version</code> (see -below), and can be disabled on the command line by running <code>npm ---no-git-tag-version version</code></p> +<p>If run in a git repo, it will also create a version commit and tag. +This behavior is controlled by <code>git-tag-version</code> (see below), and can +be disabled on the command line by running <code>npm --no-git-tag-version version</code>. +It will fail if the working directory is not clean, unless the <code>--force</code> +flag is set.</p> <p>If supplied with <code>--message</code> (shorthand: <code>-m</code>) config option, npm will use it as a commit message when creating a version commit. If the <code>message</code> config contains <code>%s</code> then that will be replaced with the @@ -29,12 +30,33 @@ user: "isaacs (http://blog.izs.me/) <i@izs.me>" Enter passphrase: </code></pre><p>If <code>preversion</code>, <code>version</code>, or <code>postversion</code> are in the <code>scripts</code> property of -the package.json, they will be executed as part of running <code>npm version</code>. -<code>preversion</code> and <code>version</code> are executed before bumping the package version, and -<code>postversion</code> is executed afterwards. For example, to run <code>npm version</code> only if -all tests pass:</p> -<pre><code>"scripts": { "preversion": "npm test" } -</code></pre><h2 id="configuration">CONFIGURATION</h2> +the package.json, they will be executed as part of running <code>npm version</code>.</p> +<p>The exact order of execution is as follows:</p> +<ol> +<li>Check to make sure the git working directory is clean before we get started. +Your scripts may add files to the commit in future steps. +This step is skipped if the <code>--force</code> flag is set.</li> +<li>Run the <code>preversion</code> script. These scripts have access to the old <code>version</code> in package.json. +A typical use would be running your full test suite before deploying. +Any files you want added to the commit should be explicitly added using <code>git add</code>.</li> +<li>Bump <code>version</code> in <code>package.json</code> as requested (<code>patch</code>, <code>minor</code>, <code>major</code>, etc). </li> +<li>Run the <code>version</code> script. These scripts have access to the new <code>version</code> in package.json +(so they can incorporate it into file headers in generated files for example). +Again, scripts should explicitly add generated files to the commit using <code>git add</code>.</li> +<li>Commit and tag.</li> +<li>Run the <code>postversion</code> script. Use it to clean up the file system or automatically push +the commit and/or tag.</li> +</ol> +<p>Take the following example:</p> +<pre><code>"scripts": { + "preversion": "npm test", + "version": "npm run build && git add -A dist", + "postversion": "git push && git push --tags && rm -rf build/temp" +} +</code></pre><p>This runs all your tests, and proceeds only if they pass. Then runs your <code>build</code> script, and +adds everything in the <code>dist</code> directory to the commit. After the commit, it pushes the new commit +and tag up to the server, and deletes the <code>build/temp</code> directory.</p> +<h2 id="configuration">CONFIGURATION</h2> <h3 id="git-tag-version">git-tag-version</h3> <ul> <li>Default: true</li> |