Skip to content

doc: use npm-published version of doc-kit#62139

Open
avivkeller wants to merge 2 commits intonodejs:mainfrom
avivkeller:bump-doc-kit
Open

doc: use npm-published version of doc-kit#62139
avivkeller wants to merge 2 commits intonodejs:mainfrom
avivkeller:bump-doc-kit

Conversation

@avivkeller
Copy link
Member

@avivkeller avivkeller commented Mar 6, 2026

Closes #62050

cc @nodejs/web-infra

Copilot AI review requested due to automatic review settings March 6, 2026 20:32
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/actions
  • @nodejs/security-wg
  • @nodejs/web-infra

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. windows Issues and PRs related to the Windows platform. labels Mar 6, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR migrates the doc-kit dependency from a GitHub archive tarball under the @nodejs scope to an npm-published package under the @node-core scope (@node-core/doc-kit@^1.0.0). This simplifies dependency management by using standard npm versioning instead of pinning to specific Git commit SHAs, and removes the custom update tooling that was only needed for the tarball-based approach.

Changes:

  • Replaced @nodejs/doc-kit (GitHub tarball) with @node-core/doc-kit@^1.0.0 (npm registry) in package.json, Makefile, and vcbuild.bat
  • Removed the custom updater script (update-doc.sh) and commit-fetching utility (get-latest-commit.mjs) that are no longer needed with npm-based versioning
  • Removed the doc-kit entry from the CI auto-update workflow (.github/workflows/tools.yml) since npm's standard npm update can handle updates via Dependabot or Renovate

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tools/doc/package.json Changed dependency from @nodejs/doc-kit (tarball URL) to @node-core/doc-kit@^1.0.0
Makefile Updated DOC_KIT path from @nodejs/doc-kit to @node-core/doc-kit
vcbuild.bat Updated doc_kit_exe path from @nodejs/doc-kit to @node-core/doc-kit
.github/workflows/tools.yml Removed the doc-kit auto-update CI matrix entry
tools/dep_updaters/update-doc.sh Deleted — no longer needed with npm-based dependency
tools/doc/get-latest-commit.mjs Deleted — no longer needed with npm-based dependency

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@avivkeller avivkeller marked this pull request as draft March 6, 2026 20:42
@codecov
Copy link

codecov bot commented Mar 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.65%. Comparing base (50fe010) to head (cdb8a4a).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #62139   +/-   ##
=======================================
  Coverage   89.65%   89.65%           
=======================================
  Files         676      676           
  Lines      206481   206543   +62     
  Branches    39544    39545    +1     
=======================================
+ Hits       185121   185178   +57     
+ Misses      13492    13486    -6     
- Partials     7868     7879   +11     

see 29 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@avivkeller
Copy link
Member Author

Looks like there might be an npm bug

@avivkeller avivkeller marked this pull request as ready for review March 6, 2026 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. windows Issues and PRs related to the Windows platform.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants