apache / apache/pulsar-client-node
node-pre-gyp setup
- Dominant language
- C++
- Stars
- 164
- Forks
- 98
- PR merge metrics
- No merged PRs in 30d
Description
The current node-pre-gyp setup is incorrect, the binary host points to the docs instead of a place where the built binaries are stored.
Things to do to improve the usage:
- [ ] Set up a CI on Mac OS and Linux (glibc and musl builds?) to build the binaries.
- [ ] Use [node-pre-gyp-github](https://github.com/bchr02/node-pre-gyp-github) tool to upload the built binaries to GitHub releases, so that users can download the binaries during install.
- [ ] This project uses N-API, so the default binary name can be optimised to not include node ABI version in it. This will allow to build a single binary per platform without the need of building it for every node version. `"{module_name}-{version}-{platform}-{libc}-{arch}.tar.gz"`
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the current node-pre-gyp setup and how its binary host and naming template are configured. Then examine the proposed node-pre-gyp-github flow and determine the CI matrix for macOS, Linux glibc, and Linux musl builds. Done means binaries are built, uploaded to GitHub releases, and downloadable during installation with the N-API-compatible name.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nodejs
- Domain
- build-system, ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100