feat(js-host-api): add npm publishing workflow by simongdavies · Pull Request #36 · hyperlight-dev/hyperlight-js

simongdavies · 2026-03-03T23:12:25Z

Summary

Adds cross-platform npm publishing for @hyperlight/js-host-api.

Changes

npm-publish.yml - New workflow that builds native binaries on Linux/Windows and publishes to npmjs.com
CreateRelease.yml - Calls npm-publish after creating GitHub release
package.json - Added napi targets and optionalDependencies for platform packages
npm/ - Platform-specific package.json files for Linux and Windows
.npmignore - Controls what gets published (includes generated index.js/index.d.ts)
README.md - Added publishing documentation

Usage

Manual: Actions → "Publish npm packages" → Run workflow (with optional dry-run)
Automatic: Triggers after CreateRelease on release/vX.Y.Z branches

Setup Required

Add NPM_TOKEN secret (npm access token with publish permissions for @hyperlight scope)

jprendes

LGTM, it would be great if we could test it in a local repo before publishing to npm, to make sure that it works as expected. There is a lot of nodejs magic in here :-)

.github/workflows/npm-publish.yml

src/js-host-api/package.json

- Add npm-publish.yml workflow for cross-platform builds (Linux/Windows x64) - Add platform-specific npm packages for native binaries - Integrate npm publish into CreateRelease workflow - Add .npmignore to control published files - Update README with publishing documentation

Copilot

Pull request overview

Adds an npm publishing pipeline for @hyperlight/js-host-api, including platform-specific binary sub-packages and documentation, and wires publishing into the release workflow.

Changes:

Introduces a new GitHub Actions workflow to build Linux/Windows N-API binaries and publish main + platform npm packages.
Updates @hyperlight/js-host-api metadata and adds platform package manifests under src/js-host-api/npm/.
Adds .npmignore rules and README documentation describing the publishing process.

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`src/js-host-api/package.json`	Adds repository metadata, napi targets, and optionalDependencies for platform packages.
`src/js-host-api/package-lock.json`	Updates lockfile to reflect new optional dependencies (currently incomplete vs `package.json`).
`src/js-host-api/npm/win32-x64-msvc/package.json`	New Windows platform package manifest for the `.node` binary.
`src/js-host-api/npm/linux-x64-musl/package.json`	New Linux musl platform package manifest for the `.node` binary.
`src/js-host-api/npm/linux-x64-gnu/package.json`	New Linux glibc platform package manifest for the `.node` binary.
`src/js-host-api/README.md`	Documents automated/manual npm publishing and platform selection behavior.
`src/js-host-api/.npmignore`	Adds publish-time include/exclude rules (currently missing an exclusion for `npm/`).
`.github/workflows/npm-publish.yml`	New workflow to build artifacts and publish npm packages (contains a critical input reference issue).
`.github/workflows/CreateRelease.yml`	Calls the npm publish workflow after creating a GitHub release and passes the derived version.

Files not reviewed (1)

src/js-host-api/package-lock.json: Language not supported

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

src/js-host-api/package-lock.json

src/js-host-api/.npmignore

.github/workflows/npm-publish.yml

src/js-host-api/README.md

Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

src/js-host-api/package-lock.json: Language not supported

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

src/js-host-api/package-lock.json

.github/workflows/npm-publish.yml

Copilot

Pull request overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.

Files not reviewed (1)

src/js-host-api/package-lock.json: Language not supported

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

.github/workflows/npm-publish.yml

Copilot

Pull request overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

src/js-host-api/package-lock.json: Language not supported

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

.github/workflows/npm-publish.yml

Copilot

Pull request overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 5 comments.

Files not reviewed (1)

src/js-host-api/package-lock.json: Language not supported

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

.github/workflows/npm-publish.yml

.github/workflows/CreateRelease.yml

src/js-host-api/package.json

src/js-host-api/.npmignore

.github/workflows/npm-publish.yml

Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

src/js-host-api/package-lock.json: Language not supported

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

src/js-host-api/README.md

simongdavies added the kind/enhancement New feature or improvement label Mar 3, 2026

jprendes previously approved these changes Mar 4, 2026

View reviewed changes

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

src/js-host-api/package.json Show resolved Hide resolved

src/js-host-api/package.json Show resolved Hide resolved

simongdavies dismissed jprendes’s stale review via ac9f766 March 17, 2026 11:03

simongdavies force-pushed the feat/npm-publish branch from 907020a to ac9f766 Compare March 17, 2026 11:03

simongdavies requested a review from Copilot March 26, 2026 21:31

Copilot started reviewing on behalf of simongdavies March 26, 2026 21:32 View session

Copilot AI reviewed Mar 26, 2026

View reviewed changes

Review Feedabck

d420f31

Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>

simongdavies force-pushed the feat/npm-publish branch from ac9f766 to d420f31 Compare March 26, 2026 23:18

simongdavies requested a review from Copilot March 26, 2026 23:19

Copilot started reviewing on behalf of simongdavies March 26, 2026 23:19 View session

Copilot AI reviewed Mar 26, 2026

View reviewed changes

src/js-host-api/package-lock.json Show resolved Hide resolved

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

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

simongdavies force-pushed the feat/npm-publish branch from d420f31 to 1863153 Compare March 27, 2026 14:59

simongdavies requested a review from Copilot March 27, 2026 15:06

Copilot started reviewing on behalf of simongdavies March 27, 2026 15:06 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

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

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

simongdavies force-pushed the feat/npm-publish branch from 1863153 to e295274 Compare March 27, 2026 15:56

simongdavies requested a review from Copilot March 27, 2026 16:14

Copilot started reviewing on behalf of simongdavies March 27, 2026 16:15 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

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

simongdavies requested a review from Copilot March 27, 2026 16:22

Copilot started reviewing on behalf of simongdavies March 27, 2026 16:23 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

Review Feedabck

ef94fd1

Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>

simongdavies force-pushed the feat/npm-publish branch from 216d46c to ef94fd1 Compare March 27, 2026 16:43

simongdavies requested a review from Copilot March 27, 2026 16:44

Copilot started reviewing on behalf of simongdavies March 27, 2026 16:44 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

src/js-host-api/README.md Show resolved Hide resolved

Conversation

simongdavies commented Mar 3, 2026

Summary

Changes

Usage

Setup Required

Uh oh!

jprendes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants