Repository navigation
tools/doc/versions.js should cache version data #32512
Description
Activity
Hey @rvagg,
Do you think that the following flow makes sense:
- Initialize and store a timestamp value at the start of the run
- Fetch latest CHANGELOG.md and store it in .cache/
timestamp-CHANGELOG.md - Check if local .cache/
timestamp-CHANGELOG.md exists locally and use that otherwise repeat step 2
Maybe simpler than that, this will be in a clean repo (in the
git clean -fdxsense) and this file can be added to .gitignore so it could be in the top level,.master_CHANGELOG.mdor 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
mastercopy unless we're actually running on master, which will lead to a truncated version list.Reacted by Hassaan PashaAcknowledged.
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
createMasterChangeloguses writeFileSync to create the.master-CHANGELOG.mdWhat do you think
- added a commit that references this issue
on Mar 27, 2020 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.
- added 2 commits that reference this issue
on Mar 31, 2020 - added a commit that references this issue
on Mar 31, 2020 - added a commit that references this issue
on Apr 6, 2020 - added a commit that references this issue
on Jul 27, 2026
make docforces a version fetch which fetches the CHANGELOG.md from this repo. This is done for each of the doc files that requires the versions list (because they are run one at a time). We should have caching in place so that the first one saves the data somewhere and subsequent runs just pick that it up. For speed, and also to save our CI hammering GitHub each time this is run.Ref: #32511