# BorderBulk SDK (API client)

[![CircleCI](https://circleci.com/gh/borderguru/borderbulk-sdk/tree/master.svg?style=svg&circle-token=5887d151bad4eec417b718101eb686b9ba8cce3b)](https://circleci.com/gh/borderguru/borderbulk-sdk/tree/master)[![codecov](https://codecov.io/gh/borderguru/borderbulk-sdk/branch/master/graph/badge.svg?token=8mPQaTxvRX)](https://codecov.io/gh/borderguru/borderbulk-sdk)

## Contributing

Format of commits you can find here: [conventional-changelog-angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).

## Releases

 * **Pushes to branches that are not master**

When you're pushing to any branch that is `not master` we are going to create and publish to npm a new beta with:
 - tag: branch name
 - version: build number on CircleCI.

Then, you can run `npm view` to get the version that was just created.

*We can study the possibility to send the new version by slack message or something.*

* **Publish**

For publish a new version. We will need to create a new version as we do in the other projects. 

1. Create a branch from master
2. $ npm --no-git-tag-version version $NEW_VERSION
3. Merge the branch into master

And then a new step to publish the version:

4. $ npm publish