tools: only fetch previous versions when necessary by richardlau · Pull Request #32518 · nodejs/node · GitHub

Refactor the logic for working out the previous versions of Node.js for
the API documentation so that the parsing (including the potential https
get) happens at most once per build (as opposed to the current once per
generated API doc).

Fixes: #32512

cc @joyeecheung @rvagg

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

CI: https://ci.nodejs.org/job/node-test-pull-request/30118/

CI: https://ci.nodejs.org/job/node-test-pull-request/30131/ (:heavy_check_mark:)

Refactor the logic for working out the previous versions of Node.js for the API documentation so that the parsing (including the potential https get) happens at most once per build (as opposed to the current once per generated API doc). Signed-off-by: Richard Lau <riclau@uk.ibm.com>

CI: https://ci.nodejs.org/job/node-test-pull-request/30278/
Linux Containered Retry: https://ci.nodejs.org/job/node-test-commit-linux-containered/19132/

Addressed @rvagg 's comments and replaced a stray console.log() in the test.

LGTM

Refactor the logic for working out the previous versions of Node.js for the API documentation so that the parsing (including the potential https get) happens at most once per build (as opposed to the current once per generated API doc). Signed-off-by: Richard Lau <riclau@uk.ibm.com> PR-URL: #32518 Fixes: #32512 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>

The only consistent failure with this PR in CI is an unrelated flake. I've opened a PR to mark the flake

Landed in 25a1f04

Refactor the logic for working out the previous versions of Node.js for the API documentation so that the parsing (including the potential https get) happens at most once per build (as opposed to the current once per generated API doc). Signed-off-by: Richard Lau <riclau@uk.ibm.com> PR-URL: #32518 Fixes: #32512 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>

@richardlau this is going to need a manual backport for 10.x, would you be able to help with that?

@richardlau this is going to need a manual backport for 10.x, would you be able to help with that?

Yes, will do.

Refactor the logic for working out the previous versions of Node.js for the API documentation so that the parsing (including the potential https get) happens at most once per build (as opposed to the current once per generated API doc). Signed-off-by: Richard Lau <riclau@uk.ibm.com> PR-URL: #32518 Fixes: #32512 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>

@richardlau this is going to need a manual backport for 10.x, would you be able to help with that?

#32642

Path to the versions tool tested by test-doctool-versions.js would be incorrect if the test temporary directory was redirected (e.g. via NODE_TEST_DIR) outside of `test/`. Signed-off-by: Richard Lau <riclau@uk.ibm.com> PR-URL: #32645 Refs: #32518 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refactor the logic for working out the previous versions of Node.js for the API documentation so that the parsing (including the potential https get) happens at most once per build (as opposed to the current once per generated API doc). Signed-off-by: Richard Lau <riclau@uk.ibm.com> Backport-PR-URL: nodejs#32642 PR-URL: nodejs#32518 Fixes: nodejs#32512 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>

Path to the versions tool tested by test-doctool-versions.js would be incorrect if the test temporary directory was redirected (e.g. via NODE_TEST_DIR) outside of `test/`. Signed-off-by: Richard Lau <riclau@uk.ibm.com> Backport-PR-URL: nodejs#32642 PR-URL: nodejs#32645 Refs: nodejs#32518 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Refactor the logic for working out the previous versions of Node.js for the API documentation so that the parsing (including the potential https get) happens at most once per build (as opposed to the current once per generated API doc). Signed-off-by: Richard Lau <riclau@uk.ibm.com> Backport-PR-URL: #32642 PR-URL: #32518 Fixes: #32512 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>

Path to the versions tool tested by test-doctool-versions.js would be incorrect if the test temporary directory was redirected (e.g. via NODE_TEST_DIR) outside of `test/`. Signed-off-by: Richard Lau <riclau@uk.ibm.com> Backport-PR-URL: #32642 PR-URL: #32645 Refs: #32518 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Path to the versions tool tested by test-doctool-versions.js would be incorrect if the test temporary directory was redirected (e.g. via NODE_TEST_DIR) outside of `test/`. Signed-off-by: Richard Lau <riclau@uk.ibm.com> PR-URL: #32645 Refs: #32518 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Mar 27, 2020

This was referenced Mar 27, 2020

tools/doc/versions.js should cache version data #32512

Closed

tools: extend timeout for doc build version fetch #32511

Closed

doc, tools: added caching support for CHANGELOG.md in tools/doc/versions.js #32515

Closed

joyeecheung approved these changes Mar 27, 2020

View reviewed changes

richardlau added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Mar 27, 2020

rvagg reviewed Mar 31, 2020

View reviewed changes

Comment thread Makefile Outdated

rvagg reviewed Mar 31, 2020

View reviewed changes

Comment thread Makefile Outdated

rvagg reviewed Mar 31, 2020

View reviewed changes

Comment thread test/doctool/test-doctool-versions.js Outdated

rvagg reviewed Mar 31, 2020

View reviewed changes

Comment thread tools/doc/versions.js Outdated

richardlau force-pushed the doccache branch from 3387385 to f628ad3 Compare March 31, 2020 09:59

MylesBorins approved these changes Mar 31, 2020

View reviewed changes

MylesBorins closed this Mar 31, 2020

MylesBorins added backport-requested-v12.x labels Mar 31, 2020

MylesBorins added backport-requested-v10.x and removed backport-requested-v12.x labels Mar 31, 2020

codebytere mentioned this pull request Apr 1, 2020

v12.16.2 proposal #32313

Merged

richardlau mentioned this pull request Apr 3, 2020

[v10.x backport] doc,tools: get altDocs versions from CHANGELOG.md #32642

Closed

3 tasks

richardlau mentioned this pull request Apr 3, 2020

test: fix tool path in test-doctool-versions.js #32645

Closed

3 tasks

BethGriggs mentioned this pull request Apr 7, 2020

v10.20.0 proposal #31984

Merged

targos mentioned this pull request Apr 8, 2020

v12.x LTS expected assets need updating nodejs/build#2276

Closed

targos mentioned this pull request Apr 13, 2020

v13.13.0 release proposal #32813

Merged

tools: only fetch previous versions when necessary by richardlau · Pull Request #32518 · nodejs/node · GitHub

Uh oh!

Uh oh!

tools: only fetch previous versions when necessary - #32518

tools: only fetch previous versions when necessary#32518
richardlau wants to merge 1 commit into
nodejs:masterfrom
richardlau:doccache

richardlau commented Mar 27, 2020

Uh oh!

nodejs-github-bot commented Mar 27, 2020

Uh oh!

nodejs-github-bot commented Mar 27, 2020 •
edited by addaleax
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nodejs-github-bot commented Mar 31, 2020 •
edited by MylesBorins
Loading

Uh oh!

Uh oh!

richardlau commented Mar 31, 2020

Uh oh!

MylesBorins left a comment

Uh oh!

MylesBorins commented Mar 31, 2020

Uh oh!

MylesBorins commented Mar 31, 2020

Uh oh!

richardlau commented Mar 31, 2020

Uh oh!

richardlau commented Apr 3, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tools: only fetch previous versions when necessary by richardlau · Pull Request #32518 · nodejs/node · GitHub

Uh oh!

Uh oh!

tools: only fetch previous versions when necessary - #32518

tools: only fetch previous versions when necessary#32518richardlau wants to merge 1 commit intonodejs:masternodejs/node:masterfrom richardlau:doccacherichardlau/node-1:doccacheCopy head branch name to clipboard

Conversation

richardlau commented Mar 27, 2020

Checklist

Uh oh!

nodejs-github-bot commented Mar 27, 2020

Uh oh!

nodejs-github-bot commented Mar 27, 2020 • edited by addaleax Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nodejs-github-bot commented Mar 31, 2020 • edited by MylesBorins Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

richardlau commented Mar 31, 2020

Uh oh!

MylesBorins left a comment

Choose a reason for hiding this comment

Uh oh!

MylesBorins commented Mar 31, 2020

Uh oh!

MylesBorins commented Mar 31, 2020

Uh oh!

richardlau commented Mar 31, 2020

Uh oh!

richardlau commented Apr 3, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tools: only fetch previous versions when necessary#32518
richardlau wants to merge 1 commit into
nodejs:masterfrom
richardlau:doccache

nodejs-github-bot commented Mar 27, 2020 •
edited by addaleax
Loading

nodejs-github-bot commented Mar 31, 2020 •
edited by MylesBorins
Loading