Skip to content

Publishing a Release

Anwesha edited this page Jun 5, 2018 · 3 revisions

Capturing some notes about generating a Node SDK release here for the benefit of anyone that needs to do it in the future.

Some things that need to be done, roughly in the order they should happen:

  • Regenerate the SDK for all the services.
    • Note the git hash of the API definitions version used
    • Note the git hash of the SDK generator used
  • Reapply / perform the post-generation changes as documented in the SDK generator Wiki
    • Update the post-generation changes documentation as needed
    • Run tsc and if something does not compile due to generator adding the classname in front of ReadableStream, remove it so it is just NodeJS.ReadableStream
  • Run the tests and make sure all are passing. Update tests as needed
  • Assess coverage. Add new tests as needed
  • Update README.md if needed, and Changelog on github wiki
  • Run npm version major, npm version minor, or npm version patch to increment the version in package.json and create a git commit and tag.
  • Run git push --follow-tags to push the commit and tag to github.
  • Run npm publish to publish the changes to npm.
  • Build the binary files and add them to the github release with npm run build, place watson.js and watson.min.js and add them to the github release
  • Add link to the changelog/migration guide in github release and publish it on github
Clone this wiki locally