Rust utils NAPI Building

This document describes the process for building and publishing the @integrationos/utils and related npm packages. Whenever common packages are modified in this repo, a new @integrationos/utils version should be created and published.

Dependencies

You will need write access to the @integrationos npm organization.

You will need to install the zig language

brew install zig

You will need to install all 3 target architectures we support

rustup target add x86_64-unknown-linux-gnu x86_64-apple-darwin aarch64-apple-darwin

You will need to install @napi-rs/cli

npm install -g @napi-rs/cli

Updating Version

In the package.json file, update the version.

Building

Build the three architectures

npm run build-all

Publishing

Do a dry-run to make sure everything is going to be published correctly. You must also go into each architecture module in npm and run the following command there as well.

npm publish --otp=<2FA_ONE_TIME_PASSWORD> --dry-run

Remove --dry-run to publish.

Tests

Tests are in the __test__ folder

npm install
npm run test