Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 1.11 KB

RELEASE.md

File metadata and controls

22 lines (14 loc) · 1.11 KB

How to Release

This project is hosted on NPM. You can see it here.

Releasing the project requires these steps:

  1. Clone the project and execute the following node command :

    NOTE : If you do not choose the correct type of change i.e major, minor or patch then patch will be used to release the package. This follows the semantic-versioning.

    node scripts/release/release.js minor
    
  2. The above release script should automatically update the package version and regenerate assets in dist & lib folders. Once assets are regenerated the script commits and tags the changes and will push them to remote and npm publish will be triggered automatically.

  3. Once publish is complete make sure it's uploaded to npm

Further explanation on the automated steps behind the release.js script can be found here