Release SDLC

Table of Contents

• Creating Releases
  • Beta Releases
  • Stable Releases
• Managing Releases

---

Creating Releases

Before learning how to create releases, it's important to understand that the HellWorks Node.js SDK codebase uses Standard Version to manage releases.

Beta Releases

Before creating a new release, you may first want to publish a number of betas to help test new code. For more information on creating pre-releases using Standard Version, click here.

1. Create a new beta release.

   npm run release:beta

   This will create a new release tagged as v2.0.0-beta.0.

2. Push to GitHub.

   git push --follow-tags origin

Stable Releases

When your changes are thoroughly code reviewed and tested, it's time to create a new stable release of the HellWorks Node.js SDK. For more information on cutting releases using Standard Version, click here.

1. Update master.

   • Create a pull request against master from develop.

2. Create the release.

   • When the pull request has been merged, pull the latest changes.

     git checkout master
     git pull origin master

   • Create the new release.

     npm run release

     This script generates the release by aliasing Standard Version which utilizes Conventional Changelog to automatically update the Changelog by compiling properly-formatted git metadata.

     To release with a specific version, use the --release-as flag.

     npm run release -- --release-as 2.3.4

   • Push the release and tag to origin.

     git push --follow-tags origin master

3. Your release should now automatically deploy.

   When a new tag is pushed, Travis will automatically build, test, and then deploy the release to npm. After deployment, Travis will then automatically upload the dist files to a new HellWorks Node.js SDK Release on GitHub.

4. Update the develop branch in one of two ways:

   1. Via git:

      git checkout develop
      git merge master
      git push origin develop

   2. Or, create a pull request from master against develop called "Update develop".

Managing Releases

After releasing a new stable version of the HellWorks Node.js SDK, it is necessary to verify that the release was successful by checking the various release channels, then update other release-dependent documentation.

1. Verify the release was successful.

   • Npm
   • GitHub Releases

2. Update the API Documentation, if applicable.

3. Update the Release Schedule, if applicable.