nodejs / nodejs/build

Store Changes to /dist/index.json

Open
#3,788 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jinja
Stars
541
Forks
185
Avg merge
22h 15m
Merged PRs (30d)
4

Description

Hey!

A while ago I built a tool to extract information from nodejs.org/dist/index.json. It runs nightly to build data for the static version of the module (the non-static version fetches data from the live site).

In those PRs, over time I've noticed a few bits flip with some regularity - specifically, the security value changes. This could absolutely be an error on my end, but it's complicated to verify that without being able to see the source of truth at the time of execution. I'd be fine to do that, but now I've noticed that the modules versions have started flipping around, too - the modules version on Node.js v20.14.0 flipped from 120 down to 115 - very odd behavior, and I'm guessing that one isn't me.

So, I was hoping that there would be some way to keep a historical log of what's published to that file. If that's just committing it to a repo every time it's changed and I can look at the diff, that's fine. Alternatively, keeping a full version every time it's changed would be nice as well. I'm really down for any solution, I'd just like to be able to see the data historically.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the nightly tool that builds the static module from /dist/index.json and compare it with the live-site data path. Define how historical versions or diffs should be stored so changes to fields such as security and modules can be inspected; done means past published values are retrievable.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js
Domain
devops, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.