-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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
doc: add guide to maintaining npm #16541
Conversation
doc/guides/maintaining-npm.md
Outdated
|
||
## Step 1: Clone npm | ||
|
||
$ git clone https://github.com/npm/npm.git |
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.
Nit: can we use the triple ` instead of the indentation? I think it's more common in our guides.
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.
```console $ git clone https://github.com/npm/npm.git ```
Would be nice
doc/guides/maintaining-npm.md
Outdated
|
||
## Step 3: Rimraf old npm | ||
|
||
$ cd ../node |
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.
Nit: I would add a comment explaining that the assumption is that the node repo is in the same directory of the npm repo.
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.
Or just cd /path/to/node
doc/guides/maintaining-npm.md
Outdated
$ git checkout vX.Y.Z | ||
$ make release | ||
|
||
## Step 3: Rimraf old npm |
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.
Remove
?
18f45e7
to
0714847
Compare
@MylesBorins do you want to wait further? |
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.
LGTM
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.
Looks good! Couple of minor bits but otherwise 👍
doc/guides/maintaining-npm.md
Outdated
|
||
```console | ||
$ git remote update -p | ||
$ git reset --hard origin master |
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.
We don't use master
. This should be latest
.
doc/guides/maintaining-npm.md
Outdated
|
||
```console | ||
$ tar zxf /path/to/npm/release/npm-x.y.z.tgz | ||
$ git add -f npm |
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.
Shouldn't this be -A
, to make sure files are both added and removed?
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.
When I was doing it with -A
it wasn't adding all the files. I believe add -f
will add and remove.
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.
As of git 2.0, git add
adds removed files as well as added files.
git add -f
is about adding gitignore
d files, not sure we'd want that. @MylesBorins which files weren't being added?
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.
Yeah, if some files are missing, we should probably modify a rule in our .gitignore
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've updated and opened #17363
doc/guides/maintaining-npm.md
Outdated
$ ./tools/license-builder.sh | ||
# The following commands are only neccessary if there are changes | ||
$ git add . | ||
$ git commit -m "doc: update npm LICENSE using license-builder.sh" |
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.
It might be worth warning folks that this might end up including changes to -other- licenses, and that wouldn't be appropriate for this commit. They should make sure to check that any changes are actually npm-check related.
|
||
```console | ||
$ git checkout vX.Y.Z | ||
$ make release |
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 the latest
dist-tag. latest
on git is usually released as next
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
doc/guides/maintaining-npm.md
Outdated
$ ./configure | ||
$ make -j4 | ||
$ ./tools/license-builder.sh | ||
# The following commands are only neccessary if there are changes |
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.
sp: necessary
0714847
to
cdb787a
Compare
Updated with requested changes. PTAL |
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.
LGTM apart from the git add -f
thing, which I'm not sure about.
doc/guides/maintaining-npm.md
Outdated
$ git checkout master | ||
$ git remote update -p | ||
$ git reset --hard origin master | ||
$ git checkout -b npm-x.y.z |
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.
Maybe just
git remote update -p
git checkout -b npm-x.y.z origin/master
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.
We explicitly want to add all files in the npm folder including those
normally ignored
This is similar to eslint / remark deps
…On Nov 26, 2017 7:54 PM, "Michaël Zasso" ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In doc/guides/maintaining-npm.md
<#16541 (comment)>:
> +
+```console
+$ cd /path/to/node
+$ git checkout master
+$ git remote update -p
+$ git reset --hard origin master
+$ git checkout -b npm-x.y.z
+$ 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 -f npm
Yeah, if some files are missing, we should probably modify a rule in our
.gitignore
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#16541 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAecV4GcrG-qDwxVOmonfmx0OCgZlP5Mks5s6UN9gaJpZM4QIgKS>
.
|
I've opened #17363 to help with the problem of files in the npm tree not being tracked by default |
I think an npm update has gotten into the branch... |
lol. This is what I get for trying to test things and multi tasking. I'll update when I get back to computer |
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
a5779e1
to
94952ac
Compare
@gibfahn ptal. This should be in working order now, I'll land in 24 hours if no one has any complaints. As this primarily mirrors the guide found on the npm wiki I don't think we need to block on the gitignore PR to land this |
@MylesBorins went ahead and pushed my suggestion, remove it if you disagree (I'm assuming it simply got lost). LGTM. This has 11 (!) approvals, and you've addressed all of @zkat's suggestions, so this should be good to land. |
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.
👍
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]>
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]>
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]>
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]>
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]>
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]>
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
/cc @nodejs/npm