Publishing a new release

For anyone who might need to generate and release the Python SDK in the future, here are some notes on the necessary steps from start to finish:

• 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 the tests and make sure all are passing. Update tests as needed

   py.test test
  

  For tests to run on various python versions:

  tox
  

• Assess coverage. Add new tests as needed

• Check for pylint issues

  sh pylint.sh
  

• Update main README.md if necessary

• Update the changelog in the wiki

  • Also update the migration guide for a major release

• Create a PR for the new release

  • PR description should include the hash for API definitions and SDK generator

• When tests pass and PR review is complete, merge PR to master

• Follow instructions in RELEASE.md to push the code to PypI

• Edit Release in GitHub repo.

  • Link changelog wiki entry
  • Also link migration guide wiki entry if it's been updated

• Publish the release.

• Merge master into develop