doc: add guide to maintaining npm

This is based on the guide found on their wiki refs: https://github.com/npm/npm/wiki/CLI-Team-Process#submitting-the-new-latest-x-to-nodejs PR-URL: #16541 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
nodejs · Dec 20, 2017 · b18cd4e · b18cd4e
1 parent 3690d73
commit b18cd4e
Showing 1 changed file with 68 additions and 0 deletions.
diff --git a/doc/guides/maintaining-npm.md b/doc/guides/maintaining-npm.md
@@ -0,0 +1,68 @@
+# Maintaining npm in Node.js
+
+## Step 1: Clone npm
+
+```console
+$ git clone https://github.com/npm/npm.git
+$ cd npm
+```
+
+or if you already have npm cloned make sure the repo is up to date
+
+```console
+$ git remote update -p
+$ git reset --hard origin latest
+```
+
+## Step 2: Build release
+
+```console
+$ git checkout vX.Y.Z
+$ make release
+```
+
+Note: please run `npm dist-tag ls npm` and make sure this is the `latest` **dist-tag**. `latest` on git is usually released as `next` when it's time to downstream
+
+## Step 3: Remove old npm
+
+```console
+$ cd /path/to/node
+$ git remote update -p
+$ git checkout -b npm-x.y.z origin/master
+$ cd deps
+$ rm -rf npm
+```
+
+## Step 4: Extract and commit new npm
+
+```console
+$ tar zxf /path/to/npm/release/npm-x.y.z.tgz
+$ git add -A npm
+$ git commit -m "deps: upgrade npm to x.y.z"
+$ cd ..
+```
+
+## Step 5: Update licenses
+
+```console
+$ ./configure
+$ make -j4
+$ ./tools/license-builder.sh
+# The following commands are only necessary if there are changes
+$ git add .
+$ git commit -m "doc: update npm LICENSE using license-builder.sh"
+```
+
+Note: please ensure you are only making the updates that are changed by npm.
+
+## Step 6: Apply Whitespace fix
+
+```console
+$ git rebase --whitespace=fix master
+```
+
+## Step 7: Test the build
+
+```console
+$ make test-npm
+```