Toolkit Release process

Edit me

The following steps should be followed to generate a new release:

  • In your local workspace, run git flow release start vX.Y.Z (assuming git-flow is installed)
    • You should now be in the release/vX.Y.Z branch
  • Change KAFKA_BASE_TAG variable in com.ibm.streamsx.messagehub/build.gradle to the Kafka toolkit tag that should be the base for this version of the toolkit.
  • Bump com.ibm.streamsx.messagehub/info.xml version number
  • Generate a release by running gradle release
  • Run a greenthread test against the release (not the toolkit in your git repo)
    1. Extract the generated release in /tmp
    2. Pick one of the samples and update the toolkitPath variable in build.gradle to point to /tmp/com.ibm.streamsx.messagehub
    3. Set the app config or update the /etc/messagehub.json file
    4. Run gradle build to build the sample
    5. Run the sample: streamtool submitjob output/<sample_name>/<sample_name>.sab
    6. DELETE the toolkit from /tmp
  • Merge release/vX.Y.Z into develop:
    • gradle clean
    • git add com.ibm.streamsx.messagehub/info.xml com.ibm.streamsx.messagehub/build.gradle
    • git commit -m "Update version to vX.Y.Z"
    • git flow release finish vX.Y.Z
  • Push develop to Github repo: git push
  • Push the tag to the Github repo: git push --tags
  • Generate SPLDocs
  • DONE!

Updated: