Permalink
Browse files

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 <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
  • Loading branch information...
MylesBorins authored and gibfahn committed Oct 27, 2017
1 parent ad9a857 commit 35316dcd10cb0122c021ee98c7197c970cc7b49e
Showing with 68 additions and 0 deletions.
  1. +68 −0 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
```

0 comments on commit 35316dc

Please sign in to comment.