@withjoy/sdk-js/README.md

Joy Javascript SDK

Joy Javascript SDK
==================


## Installing or Upgrading Packages

Please follow the Best Practices for [Care & Feeding of 'npm-shrinkwrap.json'](https://withjoy.atlassian.net/wiki/spaces/KNOW/pages/1815806077/Care+Feeding+of+npm-shrinkwrap.json).

Presently, the 'npm-shrinkwrap.json' can be successfully re-generated using Node 6 + `npm@3`.
There is no need to switch to Node 10 + `npm@6`, as the Wiki above suggests.

If the above fails:

Switch to node 16
```
nvm use 16
```

Run yarn instead of npm
```
yarn install --frozen-lockfile
```

Switch back to node 6.9
```
nvm use
```

Test to verify an working bulid
```
npm test
```

## Publishing

To publish a new version of this module,

- *do not* up-version on your development branch
- merge your fixes into `main`
- from the `main` branch,

```
npm version patch  # or whatever is suitable
```

See [npm's examples](https://docs.npmjs.com/cli/v8/commands/npm-version#synopsis) of the different levels of versions (major, minor, patch, etc.)

As a verification step (via 'preversion'),

- a fresh (local) build is produced
- the Test Suite must pass

As a follow-up,

- `package.json` is up-versioned
- a semver-ish tag is pushed to Git
- CircleCI will perform the `npm publish` operation when it detects the tag
- it's ready once the 'versions' in `npm info @withjoy/sdk-js` have been updated


## CircleCI

Its Project uses the following Environment Variables:

- ARTIFACTORY_TOKEN
- NPM_TOKEN