BorderBulk Type Definition
The type definition for the BorderBulk SDK
Contributing
Format of commits you can find here: 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 Jenkins.
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
When something is merged to master
a new release is going to be created using semantic-release
. Because of this, we are checking PR title to ensure it's using a valid format.
This repo uses the Squash and Merge convention so make sure the squash commit follows the above commit message convention.
If the squash commit message does not match the format mentioned in the contributing section, a NEW release will NOT be created.
A sample squash commit message would be:
feat: Update BulkTypes
This would result in a new minor version generated (including updates to the package and package-lock.json) and published to NPM.
N.B: Do not create tags for Borderbulk, npx semantic release handles the part of generating the next version when publishing.