Table of contents
- Prepare your environment for Node.js. We use volta to manage node versions. Follow the install guide for volta to get started.
- You will also need Docker if you regenerate the OpenAPI code.
npm install
npm test
npm run setup-examples
If you need to regenerate the OpenAPI-generated, use the script:
./generate/docker.sh
npm run clean
npm run build
When you are ready to release, make sure the version in package.json has been bumped. Then create a GitHub Release.
You can use the gh CLI tool to create a release or you can use GitHub.com.
An example gh looks something like this:
gh release create v4.5.1 --generate-notes --draft
Note: The draft needs to be published, which can be done at the printed URL.
Note: The format of the release tag should be vx.x.x e.g. v4.5.1.
Creating a release triggers a GitHub Action that publishes the package to NPM.