Release Process

Checkout the main branch

git checkout master
git pull
git submodule update --init

Bump the package.json version number as appropriate using:

npm version <major|minor|patch>

Build the package locally and audit any dependencies to produce an up-to-date yarn.lock

yarn clean
yarn build:all

Update the CHANGELOG file to reflect all changes in this release.

Amend the commit and add the updates.

If you didn't use npm version, tag the source using the version with a v prefix as above for the tagname and then:

git push
git push --tags

When a tag is pushed, the GH actions system will automatically create prebuildify binaries for the release.

Have a compatible physical test device set up and connected to the local machine. (Details)

rm -rf build
yarn install
yarn test

To undertake a normal (latest) npm publish run:

npm publish

To specify a tag (e.g, testing, alpha) use:

npm publish --tag alpha