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

Activity

1. MylesBorins

   added

   good first issueIssues that are suitable for first-time contributors.Issues that are suitable for first-time contributors.

   on Mar 27, 2020
2. hassaanp commented on Mar 27, 2020

   

   hassaanp

   on Mar 27, 2020

   Last edited by hassaanp

   Contributor

   More actions

   Hey @rvagg,

   Do you think that the following flow makes sense:

   1. Initialize and store a timestamp value at the start of the run
   2. Fetch latest CHANGELOG.md and store it in .cache/timestamp-CHANGELOG.md
   3. Check if local .cache/timestamp-CHANGELOG.md exists locally and use that otherwise repeat step 2
3. rvagg commented on Mar 27, 2020

   

   rvagg

   on Mar 27, 2020

   MemberAuthor

   More actions

   Maybe simpler than that, this will be in a clean repo (in the git clean -fdx sense) and this file can be added to .gitignore so it could be in the top level, .master_CHANGELOG.md or something like that. If it exists, use it, if it doesn't exist, fetch it. I don't think there's a good reason to do any timestamping on this.

   Unless someone thinks otherwise?

   Using https://nodejs.org/download/release/index.json is another option, which would be easy to process, but I guess the reason we use CHANGELOG.md is that we always have a local copy if this needs to be done in offline mode. We just don't have a local master copy unless we're actually running on master, which will lead to a truncated version list.

   👍React with 👍1Reacted by Hassaan Pasha
4. hassaanp commented on Mar 27, 2020

   

   hassaanp

   on Mar 27, 2020

   Contributor

   More actions

   Acknowledged.

   Here is my approach in versions.js

       ...
       const masterChangelog = path.join(srcRoot, '.master-CHANGELOG.md');
       if (kNoInternet) {
         changelog = readFileSync(file, { encoding: 'utf8' });
       } else if (existsSync(masterChangelog)) {
         changelog = readFileSync(masterChangelog, { encoding: 'utf8' });
       } else {
         try {
           changelog = await getUrl(url);
           createMasterChangelog(masterChangelog, changelog);
         }
       ...
   

   the createMasterChangelog uses writeFileSync to create the .master-CHANGELOG.md

   What do you think
5. hassaanp

   added a commit that references this issue on Mar 27, 2020

   doc, tools: added caching support for CHANGELOG.md in tools/doc/versi…

   ...

   50772d2
6. richardlau commented on Mar 27, 2020

   

   richardlau

   on Mar 27, 2020

   Last edited by richardlau

   Member

   More actions

   I've had some half finished code to address this for awhile (started since #31849 (review)). Tidied up today (using up work vacation today so had time) and submitted as #32518.
7. MylesBorins

   closed this as completedin 25a1f04on Mar 31, 2020
8. MylesBorins

   added 2 commits that reference this issue on Mar 31, 2020

   tools: only fetch previous versions when necessary

   ...

   ffdd82b

   tools: only fetch previous versions when necessary

   ...

   63a03d2
9. codebytere

   added a commit that references this issue on Mar 31, 2020

   tools: only fetch previous versions when necessary

   ...

   d577190
10. BethGriggs

    added a commit that references this issue on Apr 6, 2020

    tools: only fetch previous versions when necessary

    ...

    a175b8d
11. sjarmak

    added a commit that references this issue on Jul 27, 2026

    tools: only fetch previous versions when necessary

    ...

    25a1f04