Package development notes

To use and debug package locally you don't need publish it to NPM registry:

$ cd <package-location>
$ npm install && npm run build && npm link

After that you have to create symlink to your package in your project folder:

$ cd <project-location>
$ npm link @snyk/code-client

Publishing

Test variables:

SNYK_API_HOST is the API server host (by default: https://deeproxy.dev.snyk.io)
SNYK_AUTH_HOST is the Snyk authentication server host (by default: https://dev.snyk.io)
SNYK_API_KEY is a sessionToken of a user with access to the Snyk

$ cd <package-location>
$ SNYK_API_HOST=... SNYK_AUTH_HOST=... SNYK_API_KEY=... npm run test

Make sure you checked documentation about semantic release prefixes

For example, to make a major version your message must follow this format:

feat: <short message>

BREAKING CHANGE: <longer description>

No need to do anything else. We have CircleCI CI/CD pipeline with automatic semantic versioning.