Skip to content
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.

Sign up for GitHub

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

Jump to bottom

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

Closed
wants to merge 6 commits into from
Closed

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

wants to merge 6 commits into from

Commits on Apr 6, 2020

  1. doc,tools: get altDocs versions from CHANGELOG.md 

    Parse `CHANGELOG.md` for versions of Node.js used by the documentation
feature `View another version` so that we don't have to manually update
the list when we cut a new version or transition a release to LTS.

Backport-PR-URL: nodejs#32642
PR-URL: nodejs#27661
Reviewed-By: Rich Trott <rtrott@gmail.com>
    @richardlau
    richardlau committed Apr 6, 2020
    Configuration menu
    Copy the full SHA
    b0a4d45 View commit details
    Browse the repository at this point in the history

  2. test: fix flaky doctool and test 

    Doctool tests have been failing a lot in CI on Win2008 R2. It appears
async functions and callback-based functions are being used in
combination such that the callback-based function cannot guarantee that
it will invoke its callback. Convert the callback-based functions to
async functions so we have one paradigm and reliable results.

Backport-PR-URL: nodejs#32642
PR-URL: nodejs#29979
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
    @Trott @richardlau
    Trott authored and richardlau committed Apr 6, 2020
    Configuration menu
    Copy the full SHA
    ed69a5f View commit details
    Browse the repository at this point in the history

  3. tools: make doctool work if no internet available 

    Allow doctool to fallback to use local files if not building a release
build.

Backport-PR-URL: nodejs#32642
PR-URL: nodejs#30214
Fixes: nodejs#29918
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
    @richardlau
    richardlau committed Apr 6, 2020
    Configuration menu
    Copy the full SHA
    ac9127e View commit details
    Browse the repository at this point in the history

  4. tools: add NODE_TEST_NO_INTERNET to the doc builder 

    At the moment the doc builder tries to access the internet
for CHANGELOG information and only falls back to local sources
after the connection fails or a 5 second timeout. This means
that the doc building could take at least 7 minutes on a
machine with hijacked connection to Github for useless network
attempts. This patch adds a NODE_TEST_NO_INTERNET environment
variable to directly bypass these attempts so that docs can be
built in reasonable time on a machine like that.

Backport-PR-URL: nodejs#32642
PR-URL: nodejs#31849
Fixes: nodejs#29918
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
    @joyeecheung @richardlau
    joyeecheung authored and richardlau committed Apr 6, 2020
    Configuration menu
    Copy the full SHA
    2c3c6a0 View commit details
    Browse the repository at this point in the history

  5. tools: only fetch previous versions when necessary 

    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>
    @richardlau
    richardlau committed Apr 6, 2020
    Configuration menu
    Copy the full SHA
    df5d115 View commit details
    Browse the repository at this point in the history

  6. test: fix tool path in test-doctool-versions.js 

    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>
    @richardlau
    richardlau committed Apr 6, 2020
    Configuration menu
    Copy the full SHA
    91ea203 View commit details
    Browse the repository at this point in the history