chore(ci): publish package by avivkeller · Pull Request #624 · nodejs/doc-kit

avivkeller · 2026-03-01T01:46:32Z

Fixes #568 by publishing the library as @nodejs/doc-kit¹

IMO, we should use @nodejs over @node-core, since this package can be used outside of node core in the long-run. ↩

vercel · 2026-03-01T01:46:37Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
api-docs-tooling	Ready	Preview	Mar 4, 2026 9:33pm

codecov · 2026-03-01T01:47:19Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@64655f3). Learn more about missing BASE report.
⚠️ Report is 20 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #624   +/-   ##
=======================================
  Coverage        ?   73.87%           
=======================================
  Files           ?      145           
  Lines           ?    12867           
  Branches        ?      923           
=======================================
  Hits            ?     9505           
  Misses          ?     3357           
  Partials        ?        5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2026-03-01T01:48:13Z

`legacy-html` Generator

File	Base	Head	Diff
`webcrypto.html`	320.48 KB	334.63 KB	+14.15 KB (+4.42%)
`fs.html`	913.83 KB	927.66 KB	+13.83 KB (+1.51%)
`crypto.html`	997.50 KB	1007.81 KB	+10.31 KB (+1.03%)
`n-api.html`	758.34 KB	767.40 KB	+9.07 KB (+1.20%)
`os.html`	75.40 KB	83.60 KB	+8.20 KB (+10.87%)
`errors.html`	341.45 KB	349.54 KB	+8.09 KB (+2.37%)
`http2.html`	737.61 KB	744.28 KB	+6.66 KB (+0.90%)
`http.html`	591.74 KB	597.93 KB	+6.19 KB (+1.05%)
`cli.html`	281.36 KB	287.48 KB	+6.12 KB (+2.18%)
`util.html`	708.63 KB	714.49 KB	+5.86 KB (+0.83%)
`test.html`	813.57 KB	818.99 KB	+5.41 KB (+0.67%)
`quic.html`	137.33 KB	142.57 KB	+5.24 KB (+3.82%)
`stream.html`	803.51 KB	808.72 KB	+5.21 KB (+0.65%)
`dns.html`	210.79 KB	215.95 KB	+5.15 KB (+2.44%)
`buffer.html`	1.06 MB	1.07 MB	+4.99 KB (+0.46%)
`process.html`	677.94 KB	682.72 KB	+4.78 KB (+0.71%)
`sqlite.html`	191.59 KB	196.35 KB	+4.76 KB (+2.49%)
`net.html`	211.82 KB	216.24 KB	+4.43 KB (+2.09%)
`perf_hooks.html`	345.33 KB	349.49 KB	+4.16 KB (+1.20%)
`tls.html`	259.31 KB	263.42 KB	+4.12 KB (+1.59%)
`deprecations.html`	258.96 KB	263.05 KB	+4.09 KB (+1.58%)
`webstreams.html`	266.20 KB	270.28 KB	+4.08 KB (+1.53%)
`readline.html`	200.67 KB	204.62 KB	+3.95 KB (+1.97%)
`esm.html`	122.59 KB	126.35 KB	+3.76 KB (+3.07%)
`zlib.html`	272.53 KB	276.26 KB	+3.72 KB (+1.37%)
`events.html`	541.57 KB	545.20 KB	+3.63 KB (+0.67%)
`url.html`	318.30 KB	321.86 KB	+3.56 KB (+1.12%)
`module.html`	314.39 KB	317.90 KB	+3.51 KB (+1.12%)
`vm.html`	420.10 KB	423.52 KB	+3.42 KB (+0.81%)
`worker_threads.html`	382.93 KB	386.29 KB	+3.36 KB (+0.88%)
`child_process.html`	438.97 KB	442.26 KB	+3.29 KB (+0.75%)
`v8.html`	309.14 KB	312.33 KB	+3.19 KB (+1.03%)
`diagnostics_channel.html`	223.19 KB	226.26 KB	+3.08 KB (+1.38%)
`globals.html`	120.14 KB	123.14 KB	+3.00 KB (+2.50%)
`assert.html`	464.27 KB	466.93 KB	+2.66 KB (+0.57%)
`inspector.html`	110.75 KB	113.27 KB	+2.53 KB (+2.28%)
`dgram.html`	153.12 KB	155.64 KB	+2.52 KB (+1.64%)
`modules.html`	148.53 KB	151.05 KB	+2.52 KB (+1.70%)
`packages.html`	118.87 KB	121.25 KB	+2.38 KB (+2.00%)
`cluster.html`	195.87 KB	198.22 KB	+2.35 KB (+1.20%)
`intl.html`	40.46 KB	42.78 KB	+2.32 KB (+5.73%)
`repl.html`	215.26 KB	217.51 KB	+2.25 KB (+1.05%)
`timers.html`	87.18 KB	89.38 KB	+2.20 KB (+2.52%)
`console.html`	95.74 KB	97.90 KB	+2.16 KB (+2.26%)
`single-executable-applications.html`	87.13 KB	89.23 KB	+2.10 KB (+2.41%)
`path.html`	93.69 KB	95.76 KB	+2.07 KB (+2.21%)
`tty.html`	41.57 KB	43.63 KB	+2.06 KB (+4.97%)
`https.html`	153.59 KB	155.65 KB	+2.05 KB (+1.34%)
`async_context.html`	198.51 KB	200.56 KB	+2.05 KB (+1.03%)
`async_hooks.html`	217.73 KB	219.76 KB	+2.03 KB (+0.93%)
`index.html`	15.14 KB	17.06 KB	+1.92 KB (+12.68%)
`addons.html`	336.13 KB	338.04 KB	+1.90 KB (+0.57%)
`debugger.html`	36.24 KB	38.11 KB	+1.87 KB (+5.15%)
`tracing.html`	87.56 KB	89.42 KB	+1.86 KB (+2.13%)
`domain.html`	99.32 KB	101.17 KB	+1.85 KB (+1.86%)
`permissions.html`	35.62 KB	37.47 KB	+1.85 KB (+5.19%)
`typescript.html`	31.60 KB	33.37 KB	+1.77 KB (+5.61%)
`report.html`	186.09 KB	187.86 KB	+1.77 KB (+0.95%)
`wasi.html`	43.51 KB	45.27 KB	+1.76 KB (+4.05%)
`environment_variables.html`	22.87 KB	24.61 KB	+1.74 KB (+7.61%)
`querystring.html`	32.04 KB	33.76 KB	+1.72 KB (+5.36%)
`punycode.html`	32.69 KB	34.40 KB	+1.71 KB (+5.24%)
`string_decoder.html`	38.57 KB	40.21 KB	+1.65 KB (+4.27%)
`documentation.html`	24.09 KB	25.73 KB	+1.64 KB (+6.81%)
`embedding.html`	48.04 KB	49.68 KB	+1.64 KB (+3.41%)
`synopsis.html`	23.89 KB	25.47 KB	+1.58 KB (+6.63%)

`orama-db` Generator

File	Base	Head	Diff
`orama-db.json`	8.04 MB	8.04 MB	-1.04 KB (-0.01%)

`web` Generator

File	Base	Head	Diff
`deprecations.html`	510.24 KB	494.67 KB	-15.57 KB (-3.05%)
`cli.html`	502.62 KB	487.66 KB	-14.96 KB (-2.98%)
`quic.html`	368.40 KB	354.05 KB	-14.35 KB (-3.90%)
`fs.html`	1.29 MB	1.28 MB	-12.48 KB (-0.94%)
`n-api.html`	814.52 KB	803.76 KB	-10.76 KB (-1.32%)
`errors.html`	465.94 KB	456.16 KB	-9.79 KB (-2.10%)
`http.html`	712.74 KB	703.16 KB	-9.58 KB (-1.34%)
`http2.html`	742.13 KB	732.85 KB	-9.28 KB (-1.25%)
`webcrypto.html`	528.45 KB	520.66 KB	-7.79 KB (-1.47%)
`globals.html`	233.02 KB	225.84 KB	-7.17 KB (-3.08%)
`webstreams.html`	343.91 KB	336.88 KB	-7.03 KB (-2.04%)
`process.html`	656.32 KB	649.45 KB	-6.87 KB (-1.05%)
`net.html`	357.47 KB	351.02 KB	-6.45 KB (-1.80%)
`perf_hooks.html`	373.03 KB	367.04 KB	-5.99 KB (-1.61%)
`crypto.html`	987.57 KB	982.99 KB	-4.58 KB (-0.46%)
`tls.html`	353.23 KB	348.70 KB	-4.54 KB (-1.28%)
`addons.html`	259.25 KB	263.11 KB	+3.86 KB (+1.49%)
`worker_threads.html`	355.64 KB	351.89 KB	-3.76 KB (-1.06%)
`buffer.html`	855.53 KB	851.96 KB	-3.57 KB (-0.42%)
`os.html`	132.04 KB	135.54 KB	+3.50 KB (+2.65%)
`zlib.html`	279.95 KB	276.71 KB	-3.24 KB (-1.16%)
`dns.html`	285.63 KB	282.66 KB	-2.96 KB (-1.04%)
`util.html`	655.26 KB	652.37 KB	-2.89 KB (-0.44%)
`events.html`	438.30 KB	435.48 KB	-2.82 KB (-0.64%)
`inspector.html`	167.79 KB	165.18 KB	-2.61 KB (-1.55%)
`dgram.html`	186.67 KB	184.07 KB	-2.60 KB (-1.39%)
`timers.html`	127.13 KB	124.84 KB	-2.29 KB (-1.80%)
`modules.html`	177.98 KB	175.77 KB	-2.21 KB (-1.24%)
`cluster.html`	192.01 KB	189.82 KB	-2.19 KB (-1.14%)
`readline.html`	240.92 KB	238.79 KB	-2.12 KB (-0.88%)
`console.html`	141.77 KB	139.68 KB	-2.09 KB (-1.48%)
`tty.html`	90.61 KB	88.55 KB	-2.06 KB (-2.28%)
`sqlite.html`	248.35 KB	246.31 KB	-2.04 KB (-0.82%)
`packages.html`	155.47 KB	153.49 KB	-1.98 KB (-1.27%)
`path.html`	134.30 KB	132.36 KB	-1.93 KB (-1.44%)
`diagnostics_channel.html`	221.34 KB	219.49 KB	-1.85 KB (-0.84%)
`v8.html`	305.93 KB	304.12 KB	-1.82 KB (-0.59%)
`stream.html`	820.34 KB	818.67 KB	-1.67 KB (-0.20%)
`punycode.html`	62.82 KB	61.39 KB	-1.44 KB (-2.29%)
`wasi.html`	67.97 KB	66.59 KB	-1.38 KB (-2.03%)
`module.html`	306.17 KB	304.83 KB	-1.34 KB (-0.44%)
`url.html`	333.93 KB	332.63 KB	-1.30 KB (-0.39%)
`vm.html`	350.32 KB	349.03 KB	-1.29 KB (-0.37%)
`querystring.html`	62.28 KB	61.01 KB	-1.27 KB (-2.04%)
`https.html`	145.76 KB	144.55 KB	-1.21 KB (-0.83%)
`report.html`	173.68 KB	174.89 KB	+1.20 KB (+0.69%)
`single-executable-applications.html`	105.00 KB	103.87 KB	-1.13 KB (-1.08%)
`environment_variables.html`	44.02 KB	43.02 KB	-1021.00 B (-2.27%)
`tracing.html`	83.44 KB	82.48 KB	-983.00 B (-1.15%)
`string_decoder.html`	54.29 KB	53.34 KB	-967.00 B (-1.74%)
`documentation.html`	38.07 KB	37.15 KB	-938.00 B (-2.41%)
`typescript.html`	53.42 KB	52.51 KB	-924.00 B (-1.69%)
`repl.html`	176.85 KB	176.00 KB	-876.00 B (-0.48%)
`synopsis.html`	42.57 KB	41.74 KB	-846.00 B (-1.94%)
`child_process.html`	363.11 KB	362.32 KB	-808.00 B (-0.22%)
`permissions.html`	54.77 KB	54.08 KB	-705.00 B (-1.26%)
`test.html`	699.51 KB	698.83 KB	-692.00 B (-0.10%)
`async_context.html`	158.79 KB	158.18 KB	-631.00 B (-0.39%)
`debugger.html`	54.07 KB	53.61 KB	-475.00 B (-0.86%)
`index.html`	35.67 KB	35.21 KB	-465.00 B (-1.27%)
`esm.html`	152.69 KB	152.25 KB	-457.00 B (-0.29%)
`intl.html`	57.62 KB	57.19 KB	-445.00 B (-0.75%)
`assert.html`	321.30 KB	321.73 KB	+436.00 B (+0.13%)
`async_hooks.html`	155.61 KB	155.25 KB	-371.00 B (-0.23%)
`embedding.html`	58.88 KB	58.52 KB	-363.00 B (-0.60%)
`deprecations.js`	313.74 KB	313.44 KB	-307.00 B (-0.10%)
`cli.js`	325.39 KB	325.12 KB	-283.00 B (-0.08%)
`single-executable-applications.js`	88.68 KB	88.42 KB	-271.00 B (-0.30%)
`domain.html`	102.11 KB	102.23 KB	+127.00 B (+0.12%)
`webstreams.js`	320.83 KB	320.77 KB	-63.00 B (-0.02%)
`module.js`	343.11 KB	343.07 KB	-35.00 B (-0.01%)
`repl.js`	215.40 KB	215.37 KB	-29.00 B (-0.01%)
`tls.js`	349.38 KB	349.36 KB	-25.00 B (-0.01%)
`styles.css`	128.21 KB	128.22 KB	+14.00 B (+0.01%)
`buffer.js`	1.13 MB	1.13 MB	-13.00 B (-0.00%)
`addons.js`	299.72 KB	299.72 KB	+5.00 B (+0.00%)
`assert.js`	467.59 KB	467.59 KB	+5.00 B (+0.00%)
`async_context.js`	194.17 KB	194.18 KB	+5.00 B (+0.00%)
`async_hooks.js`	201.30 KB	201.30 KB	+5.00 B (+0.00%)
`child_process.js`	489.11 KB	489.12 KB	+5.00 B (+0.00%)
`cluster.js`	206.89 KB	206.89 KB	+5.00 B (+0.00%)
`console.js`	114.73 KB	114.73 KB	+5.00 B (+0.00%)
`crypto.js`	1.24 MB	1.24 MB	+5.00 B (+0.00%)
`debugger.js`	31.09 KB	31.09 KB	+5.00 B (+0.02%)
`dgram.js`	185.12 KB	185.13 KB	+5.00 B (+0.00%)
`diagnostics_channel.js`	255.86 KB	255.87 KB	+5.00 B (+0.00%)
`dns.js`	292.44 KB	292.44 KB	+5.00 B (+0.00%)
`documentation.js`	9.72 KB	9.73 KB	+5.00 B (+0.05%)
`domain.js`	93.08 KB	93.08 KB	+5.00 B (+0.01%)
`embedding.js`	37.28 KB	37.28 KB	+5.00 B (+0.01%)
`environment_variables.js`	15.13 KB	15.13 KB	+5.00 B (+0.03%)
`errors.js`	413.89 KB	413.90 KB	+5.00 B (+0.00%)
`esm.js`	139.78 KB	139.78 KB	+5.00 B (+0.00%)
`events.js`	575.76 KB	575.77 KB	+5.00 B (+0.00%)
`fs.js`	1.33 MB	1.33 MB	+5.00 B (+0.00%)
`globals.js`	141.34 KB	141.34 KB	+5.00 B (+0.00%)
`http.js`	742.94 KB	742.94 KB	+5.00 B (+0.00%)
`http2.js`	863.37 KB	863.38 KB	+5.00 B (+0.00%)
`https.js`	166.44 KB	166.45 KB	+5.00 B (+0.00%)
`index.js`	9.51 KB	9.51 KB	+5.00 B (+0.05%)
`inspector.js`	132.83 KB	132.83 KB	+5.00 B (+0.00%)
`intl.js`	37.06 KB	37.07 KB	+5.00 B (+0.01%)
`modules.js`	158.24 KB	158.25 KB	+5.00 B (+0.00%)
`n-api.js`	721.30 KB	721.30 KB	+5.00 B (+0.00%)
`net.js`	321.67 KB	321.67 KB	+5.00 B (+0.00%)
`os.js`	116.34 KB	116.35 KB	+5.00 B (+0.00%)
`packages.js`	126.23 KB	126.24 KB	+5.00 B (+0.00%)
`path.js`	105.32 KB	105.32 KB	+5.00 B (+0.00%)
`perf_hooks.js`	406.03 KB	406.03 KB	+5.00 B (+0.00%)
`permissions.js`	28.46 KB	28.46 KB	+5.00 B (+0.02%)
`process.js`	747.61 KB	747.62 KB	+5.00 B (+0.00%)
`punycode.js`	30.23 KB	30.24 KB	+5.00 B (+0.02%)
`querystring.js`	33.02 KB	33.03 KB	+5.00 B (+0.01%)
`quic.js`	220.25 KB	220.25 KB	+5.00 B (+0.00%)
`readline.js`	238.88 KB	238.88 KB	+5.00 B (+0.00%)
`report.js`	188.53 KB	188.54 KB	+5.00 B (+0.00%)
`sqlite.js`	251.06 KB	251.06 KB	+5.00 B (+0.00%)
`stream.js`	909.94 KB	909.94 KB	+5.00 B (+0.00%)
`string_decoder.js`	32.32 KB	32.33 KB	+5.00 B (+0.02%)
`synopsis.js`	15.70 KB	15.71 KB	+5.00 B (+0.03%)
`test.js`	902.74 KB	902.74 KB	+5.00 B (+0.00%)
`timers.js`	107.82 KB	107.83 KB	+5.00 B (+0.00%)
`tracing.js`	78.84 KB	78.85 KB	+5.00 B (+0.01%)
`tty.js`	54.21 KB	54.22 KB	+5.00 B (+0.01%)
`typescript.js`	25.36 KB	25.36 KB	+5.00 B (+0.02%)
`url.js`	354.43 KB	354.43 KB	+5.00 B (+0.00%)
`util.js`	797.04 KB	797.04 KB	+5.00 B (+0.00%)
`v8.js`	355.28 KB	355.28 KB	+5.00 B (+0.00%)
`vm.js`	465.45 KB	465.46 KB	+5.00 B (+0.00%)
`wasi.js`	44.80 KB	44.80 KB	+5.00 B (+0.01%)
`webcrypto.js`	464.93 KB	464.93 KB	+5.00 B (+0.00%)
`worker_threads.js`	420.88 KB	420.88 KB	+5.00 B (+0.00%)
`zlib.js`	334.44 KB	334.44 KB	+5.00 B (+0.00%)

Copilot

Pull request overview

Adds the missing metadata and CI automation needed to publish this repository’s npm package (@nodejs/doc-kit) when the version is bumped on main, aligning with the goal of automated releases.

Changes:

Add a version field to package.json.
Update npm-shrinkwrap.json to include the package version metadata.
Introduce a new GitHub Actions workflow to publish to npm and send a Slack notification.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 5 comments.

File	Description
package.json	Adds an explicit package version required for npm publishing.
npm-shrinkwrap.json	Records the package version in the shrinkwrap metadata.
.github/workflows/publish.yml	Adds an automated npm publish workflow gated by a version change check.

Files not reviewed (1)

npm-shrinkwrap.json: Language not supported

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

.github/workflows/publish.yml

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

AugustinMauroy

LGMT !

package.json

.github/workflows/publish.yml

chore(ci): publish package

803642a

Copilot AI review requested due to automatic review settings March 1, 2026 01:46

avivkeller requested a review from a team as a code owner March 1, 2026 01:46

avivkeller added the blocked label Mar 1, 2026

Copilot started reviewing on behalf of avivkeller March 1, 2026 01:46 View session

This was referenced Mar 1, 2026

OIDC + Slack Token for nodejs/doc-kit nodejs/admin#1046

Open

tools: update doc-kit to https://github.com/nodejs/doc-kit/archive/e4c566257b3cd50be14cdbc21761e7c65e0aa1a4.tar.gz nodejs/node#62050

Open

Copilot AI reviewed Mar 1, 2026

View reviewed changes

Update .github/workflows/publish.yml

dde2a56

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

vercel bot deployed to Preview March 1, 2026 01:52 View deployment

AugustinMauroy approved these changes Mar 1, 2026

View reviewed changes

package.json Show resolved Hide resolved

.github/workflows/publish.yml Outdated Show resolved Hide resolved

flakey5 approved these changes Mar 1, 2026

View reviewed changes

.github/workflows/publish.yml Show resolved Hide resolved

ovflowd marked this pull request as draft March 4, 2026 11:46

set up slack token

1aea85c

vercel bot deployed to Preview March 4, 2026 21:33 View deployment

avivkeller mentioned this pull request Mar 4, 2026

chore(deps): bump doc-kit in remark-lint nodejs/nodejs.org#8694

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(ci): publish package#624

chore(ci): publish package#624
avivkeller wants to merge 3 commits intomainfrom
publish

avivkeller commented Mar 1, 2026 •

edited

Loading

Uh oh!

vercel bot commented Mar 1, 2026 •

edited

Loading

Uh oh!

codecov bot commented Mar 1, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 1, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AugustinMauroy left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

avivkeller commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Footnotes

Uh oh!

vercel bot commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

legacy-html Generator

orama-db Generator

web Generator

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AugustinMauroy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

avivkeller commented Mar 1, 2026 •

edited

Loading

vercel bot commented Mar 1, 2026 •

edited

Loading

codecov bot commented Mar 1, 2026 •

edited

Loading

github-actions bot commented Mar 1, 2026 •

edited

Loading

`legacy-html` Generator

`orama-db` Generator

`web` Generator