build: run npm install for doc builds in tarball
#8413
Closed
Conversation
This file contains 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
addaleax
added
doc
| @@ -39,6 +39,7 @@ EXEEXT := $(shell $(PYTHON) -c \ | |||
| NODE_EXE = node$(EXEEXT) | |||
| NODE ?= ./$(NODE_EXE) | |||
| NODE_G_EXE = node_g$(EXEEXT) | |||
| NPM ?= $(PWD)/deps/npm/bin/npm-cli.js | |||
There was a problem hiding this comment.
I'd probably drop $(PWD) because that breaks if the path contains spaces (unless you quote its uses below.)
There was a problem hiding this comment.
@bnoordhuis Thanks for the hint! I’ve went with quoting the uses below, if that’s okay, that makes it a bit less messy there…
|
Edit: missed that you only did it if the local one didn't exist. I guess path to |
| @@ -308,11 +309,17 @@ out/doc/%: doc/% | |||
| # check if ./node is actually set, else use user pre-installed binary | |||
| gen-json = tools/doc/generate.js --format=json $< > $@ | |||
| out/doc/api/%.json: doc/api/%.md | |||
| [ -e tools/doc/node_modules/js-yaml/package.json ] || \ | |||
| [ -e tools/eslint/node_modules/js-yaml/package.json ] || \ | |||
| ( cd tools/doc && ( $(NODE) "$(NPM)" install || node "$(NPM)" install ) ) | |||
There was a problem hiding this comment.
Maybe prefix with [ -x $(NODE) ] or wrap the whole block in a if [ -x $(NODE) ]; then ... fi? That's what the surrounding code does.
Run `npm install` before building the documentation from release tarballs. The doctool currently depends on `js-yaml`, which is imported from the `tools/eslint` subtree; however, release tarballs don’t contain that directory. Running `npm install` is clearly not a beautiful solution, but it works. Fixes: nodejs#7872
addaleax
force-pushed
the
build-doctool-npm-install
branch
from
654f615
to
e921852
Compare
|
Okay, slightly different (and even more verbose…) approach based on @bnoordhuis’ suggestion. |
|
Not a work of beauty but shell-in-makefiles hardly ever is. LGTM. |
|
LGTM |
|
Landed in 9391cb0, thanks for the reviews! |
addaleax
added a commit
that referenced
this pull request
Sep 20, 2016
Run `npm install` before building the documentation from release tarballs. The doctool currently depends on `js-yaml`, which is imported from the `tools/eslint` subtree; however, release tarballs don’t contain that directory. Running `npm install` is clearly not a beautiful solution, but it works. Fixes: #7872 PR-URL: #8413 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com>
Fishrock123
pushed a commit
that referenced
this pull request
Oct 11, 2016
Run `npm install` before building the documentation from release tarballs. The doctool currently depends on `js-yaml`, which is imported from the `tools/eslint` subtree; however, release tarballs don’t contain that directory. Running `npm install` is clearly not a beautiful solution, but it works. Fixes: #7872 PR-URL: #8413 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 14, 2016
Run `npm install` before building the documentation from release tarballs. The doctool currently depends on `js-yaml`, which is imported from the `tools/eslint` subtree; however, release tarballs don’t contain that directory. Running `npm install` is clearly not a beautiful solution, but it works. Fixes: #7872 PR-URL: #8413 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 17, 2016
Run `npm install` before building the documentation from release tarballs. The doctool currently depends on `js-yaml`, which is imported from the `tools/eslint` subtree; however, release tarballs don’t contain that directory. Running `npm install` is clearly not a beautiful solution, but it works. Fixes: #7872 PR-URL: #8413 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com>
rvagg
pushed a commit
that referenced
this pull request
Oct 18, 2016
Run `npm install` before building the documentation from release tarballs. The doctool currently depends on `js-yaml`, which is imported from the `tools/eslint` subtree; however, release tarballs don’t contain that directory. Running `npm install` is clearly not a beautiful solution, but it works. Fixes: #7872 PR-URL: #8413 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 26, 2016
Run `npm install` before building the documentation from release tarballs. The doctool currently depends on `js-yaml`, which is imported from the `tools/eslint` subtree; however, release tarballs don’t contain that directory. Running `npm install` is clearly not a beautiful solution, but it works. Fixes: #7872 PR-URL: #8413 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com>
Closed
MylesBorins
added a commit
that referenced
this pull request
Oct 26, 2016
This LTS release comes with 219 commits. This includes 80 commits that
are docs related, 58 commits that are test related, 20 commits that
are build / tool related, and 9 commits that are updates to
dependencies.
Notable Changes
* build:
- It is now possible to build the documentation from the release
tarball (Anna Henningsen)
#8413
* buffer:
- Buffer will no longer incorrectly return a zero filled buffer when
an encoding is passed (Teddy Katz)
#9238
* deps:
- upgrade npm in LTS to 2.15.11 (Kat Marchán)
#8928
* repl:
- Enable tab completion for global properties (Lance Ball)
#7369
* url:
- `url.format()` will now encode all `#` in `search` (Ilkka Myller)
#8072
PR-URL: #9298
MylesBorins
added a commit
that referenced
this pull request
Oct 26, 2016
This LTS release comes with 219 commits. This includes 80 commits that
are docs related, 58 commits that are test related, 20 commits that
are build / tool related, and 9 commits that are updates to
dependencies.
Notable Changes
* build:
- It is now possible to build the documentation from the release
tarball (Anna Henningsen)
#8413
* buffer:
- Buffer.alloc() will no longer incorrectly return a zero filled
buffer when an encoding is passed (Teddy Katz)
#9238
* deps:
- upgrade npm in LTS to 2.15.11 (Kat Marchán)
#8928
* repl:
- Enable tab completion for global properties (Lance Ball)
#7369
* url:
- `url.format()` will now encode all `#` in `search` (Ilkka Myller)
#8072
PR-URL: #9298
MylesBorins
added a commit
that referenced
this pull request
Nov 7, 2016
This LTS release comes with 219 commits. This includes 80 commits that
are docs related, 58 commits that are test related, 20 commits that
are build / tool related, and 9 commits that are updates to
dependencies.
Notable Changes
* build:
- It is now possible to build the documentation from the release
tarball (Anna Henningsen)
#8413
* buffer:
- Buffer.alloc() will no longer incorrectly return a zero filled
buffer when an encoding is passed (Teddy Katz)
#9238
* deps:
- upgrade npm in LTS to 2.15.11 (Kat Marchán)
#8928
* repl:
- Enable tab completion for global properties (Lance Ball)
#7369
* url:
- `url.format()` will now encode all `#` in `search` (Ilkka Myller)
#8072
PR-URL: #9298
MylesBorins
added a commit
that referenced
this pull request
Nov 8, 2016
This LTS release comes with 219 commits. This includes 80 commits that
are docs related, 58 commits that are test related, 20 commits that
are build / tool related, and 9 commits that are updates to
dependencies.
Notable Changes
* build:
- It is now possible to build the documentation from the release
tarball (Anna Henningsen)
#8413
* buffer:
- Buffer.alloc() will no longer incorrectly return a zero filled
buffer when an encoding is passed (Teddy Katz)
#9238
* deps:
- upgrade npm in LTS to 2.15.11 (Kat Marchán)
#8928
* repl:
- Enable tab completion for global properties (Lance Ball)
#7369
* url:
- `url.format()` will now encode all `#` in `search` (Ilkka Myller)
#8072
PR-URL: #9298
imyller
added a commit
to imyller/meta-nodejs
that referenced
this pull request
Nov 11, 2016
This LTS release comes with 219 commits. This includes 80 commits that
are docs related, 58 commits that are test related, 20 commits that
are build / tool related, and 9 commits that are updates to
dependencies.
Notable Changes
* build:
- It is now possible to build the documentation from the release
tarball (Anna Henningsen)
nodejs/node#8413
* buffer:
- Buffer.alloc() will no longer incorrectly return a zero filled
buffer when an encoding is passed (Teddy Katz)
nodejs/node#9238
* deps:
- upgrade npm in LTS to 2.15.11 (Kat Marchan)
nodejs/node#8928
* repl:
- Enable tab completion for global properties (Lance Ball)
nodejs/node#7369
* url:
- `url.format()` will now encode all `#` in `search` (Ilkka Myller)
nodejs/node#8072
PR-URL: nodejs/node#9298
Signed-off-by: Ilkka Myller <ilkka.myller@nodefield.com>
This was referenced Mar 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Checklist
make -j4 test(UNIX), orvcbuild test nosign(Windows) passesAffected core subsystem(s)
build
Description of change
Run
npm installbefore building the documentation from release tarballs. The doctool currently depends onjs-yaml, which is imported from thetools/eslintsubtree; however, release tarballs don’t contain that directory.Running
npm installis clearly not a beautiful solution, but it works, and this has been on my to-do list for long enough… If anyone has better ideas, please voice them!Fixes: #7872