neru-alpha

NERU-SDK

Git

We're using GitHub flow - a lightweight, branch-based workflow.

To start working on a new feature create a new branch from the master. When you are finished with your work, create a PR back to the master branch.

Releasing NERU-SDK

We're using GitHub actions to run tests and publish a new package when a new release is created, thus:

Prerequisites:

• Make sure you have python3, nodejs and pip3 installed
• Install bumpver by running pip3 install bumpver

Release process:

• Bump package version by typing npm bumpVersion:[ major | minor | patch ]
  • It will bump the version for nodejs and python SDKs
• Update CHANGELOG.md in nodejs folder
• Commit changes and push to master
• Run tests locally by typing npm test in the nodejs folderª
• Create a new release from the repository
  • Specify the tag name which is the version number e.g v1.0.0
  • Add a release title e.g v1.0.0
  • Add a description for the release
  • Publish the release. This will create a new release on GitHub and starts the release process using GitHub Actions.