-
-
Notifications
You must be signed in to change notification settings - Fork 31.8k
doc: add guide to maintaining npm #16541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add a note to run
npm dist-tag ls npm
and make sure this is thelatest
dist-tag.latest
on git is usually released asnext
when it's time to downstream.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed below