Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #624 +/- ##
=======================================
Coverage ? 72.47%
=======================================
Files ? 144
Lines ? 12604
Branches ? 872
=======================================
Hits ? 9135
Misses ? 3464
Partials ? 5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
| File | Base | Head | Diff |
|---|---|---|---|
orama-db.json |
8.04 MB | 8.04 MB | +1.00 B (+0.00%) |
There was a problem hiding this comment.
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
versionfield topackage.json. - Update
npm-shrinkwrap.jsonto include the packageversionmetadata. - 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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| { | ||
| "name": "@nodejs/doc-kit", | ||
| "type": "module", | ||
| "version": "1.0.0", |
There was a problem hiding this comment.
| "version": "1.0.0", | |
| "version": "0.1.0", |
IMO we should stay in v0 and before v1 decide which parser/generator will be include in "doc-kit core" and in external package.
| :bust_in_silhouette: *Published by*: ${{ github.triggering_actor }} | ||
| :octocat: *Commit*: <https://github.com/${{ github.repository }}/commit/${{ env.COMMIT_SHA }}|${{ env.COMMIT_SHA }}> | ||
| SLACK_USERNAME: nodejs-bot | ||
| SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }} |
Fixes #568 by publishing the library as
@nodejs/doc-kit1Blocked by: nodejs/admin#1046
Footnotes
IMO, we should use
@nodejsover@node-core, since this package can be used outside of node core in the long-run. ↩