Skip to content

About

Public monitor/status/health board for @npm/cli-team's maintained projects

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

213 stars

Watchers

19 watching

Forks

Repository files navigation

📊 statusboard

npm.github.io/statusboard

A single view to help monitor the status/health of the @npm/cli teams's Open Source Projects.

CLI dependencies

The separate CLI deps page shows npm-owned dependency repositories required by the configured CLI lines. Select a CLI line and Not latest in line to find integrations missing the newest stable release in a required major; Latest overall not integrated also compares across majors. Expand a repository for exact package versions, published releases, branch HEADs, checks, and dependency paths.

The collector derives runtime and dev-only requirements from pinned CLI lockfiles and workspace manifests, including testing/linting dependencies. It retains template-oss itself but excludes transitives reachable only through it. Branches are discovered and matched by package manifests, not maintained in a dependency-branch list. Potential gaps are missing branch mappings, not confirmed support violations or upgrade recommendations.

CLI inputs and the template-oss scope rule are configured in cli-deps-policy.js. Generated data lives in cli-deps.json, independently of project-health data. Collection failures retain the previous dataset and record an error in the shared metadata file; the page displays the last success and failed/stale refreshes.

Refresh locally with npm run fetch:cli-deps -w data using AUTH_TOKEN, or use the existing gh workflow run fetch-data.yml trigger. The daily/manual data workflow refreshes both datasets. PRs build both pages into the Pages artifact; the existing main-branch publish workflow deploys them after merge.

Data

Adding a project

GitHub search query for org:npm topic:npm-cli fork:true

To be included here a repo must be in the npm org and have the npm-cli topic added to it. The data is rebuilt daily so the repo should appear by the next day.

Repos are also searched for workspaces via the package.json#workspaces array and those are included if they do not have package.json#private.

Removing a project

Projects are removed from the list if they are archived on GitHub and deprecated on the npm registry, or if they are archived and moved to a workspace of another repo we track. The topic npm-cli does not need to be removed and should be kept on GitHub repos for historical reference.

Developing:

To update maintained projects:

Locally: npm run fetch:maintained -w data

CI: gh workflow run fetch-maintained.yml

To update daily data:

Locally: npm run fetch:data -w data

CI: gh workflow run fetch-data.yml

Serve / Publish Site

Serve: npm run dev -w www

Publish: The site is published to GitHub Pages on all pushes to main.

Forking

This project aims to have some portability, but it will not work out-of-the-box if forked. Here are the things we're aware of that you should change if you fork this:

  • Enable the GitHub Action workflows after forking. They are not enabled by default on forked repos
  • Update misc links and references to your org
  • Delete all historical data from workspaces/www/lib/data/**/*.json
  • Update the necessary config items in:
  • Have a AUTH_TOKEN=${{ GITHUB TOKEN}} in workspaces/data/.env if you are fetching data locally. All the data here is from open source repos and packages on the npm registry. So if you're data is private this token will need to have the proper scopes. You can look in data/lib/api/ to see all the calls that are made.
  • Run npm run fetch:maintained -w data and npm run fetch:data -w data to populate your new data

About

Public monitor/status/health board for @npm/cli-team's maintained projects

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

213 stars

Watchers

19 watching

Forks

Used by

Contributors

Languages