Scenarioo Release Procedure

We use the git flow branching strategy (see branching Strategy).

Whenever you see <version> in this guide we mean a version number in the form 1.2.0 (without v prefix!).

Set Release Versions

In build.gradle you have to adjust following version information:

  • documentationVersion: this is the version that identifies the documentation URL for this release, which is{documentationVersion} for links into the documentation of that same release version. Please put the major version (e.g. "4.0") of the new release you gona to release (see releasing the docu later).

  • scenariooApiVersion: which writer library version to use in this release. If the library has been changed, we have to release it first. Use a non snapshot version for the release in any case!

  • scenariooAggregatedDataFormatVersion: set it to a new version in case the internal aggregated data format somehow changed in a release, which makes it necessary on an update, that all imported builds need to be reimported. Usually this should be the same as the Scenarioo version that you are going to release. If you are a 100% sure that the internal format did not change since the last release, you can keep the version from the previous release.

Search Documentation for occurrences of old version number and replace with new version:

Prepare Release Notes and Migration Guide

  • Go to file and prepare the release notes for the next version
  • If needed write a migration guide for the new version in Migration Guide
  • Let both review by the team and finalize these important release documents.

Create Release Branch and Stabilize

  • Create a release branch:
    • Make sure you have checked out the develop branch and are updated to latest changes.
    • git checkout -b release/<version> develop
  • Change on the release branch in docs/book.json the following properties to the new version of the docu:
    • the selected version in the dropdown to point to right version (move "selected": true)
    • the edit link for editing the docu to point to the correct version of the release branch (instead of develop):
      "edit-link": {
      "base": "",
      "label": "Edit This Page"
  • Push the release branch and make sure it builds on our build server.
  • Configure the new release branch to be not allowed to delete on github (under Settings\Branches) - since we keep release branches for maintanance of major releases!
  • Merge the release branch (with changes for docu) to develop branch.
  • On the develop branch: change the docu version back to "develop" (selection in dropdown and edit link) to be ready for development for next release again.
  • Inform the team about the release branch and that release stabilisation has to be done on that branch as follows.
  • Test the release version thoroughly on the demo.
  • Ask some devs to maybe do some release candidate testing in their projects.
  • Fix the bugs you find and merge the fixes to the release branch (instead of develop directly!).
  • Also proceed with further release preparations as explained in next sections

Prepare Documentation and Webpage for new Release

For Major Versions

  • See Documentation and Webpage for further instructions how to configure the documentation for a new release.

  • Prepare everything as described in that other instructions on the release branch:

    • You should at least check that the docu version for the new release branch is properly published under{version} (e.g. /4.0) - it should be published automatically by the Circle CI pipeline on your release branch (see Build Results Page).
    • Verify also in the published docu for the new version, that the correct new version is displayed and selected in the version selection dropdown in the upper left corner.
  • If for the release the web page needs to be upgraded, prepare this on a special release branch as well.

For any Version - even for patches

  • Do not forget to update the usage instructions for the Docker Image to use the newest version:
    Scenarioo Viewer Docker Image (!! change the version number in the example!)

Build Final Release Package

Once everything is ready to release and well tested, proceed as follows:

  • Tag the release (on release branch):

    git tag -a <version>
    git push --tags

    We use version number like 4.0.0 (NO v prefix!)

  • Restart the latest release build on CircleCI on the release branch, which has the same commit id as the tag. As the build uses the git tag as a version number, it's important to distribute a build artifact that was built after the tag was pushed!

  • Once the build has completed on release branch download the built WAR file (scenarioo.war) as the final release artifact and rename it to scenarioo-.war (to be published later).

Build Docker Image and Publish to Dockerhub

  • Create a new Docker image for this release according to this manual

Publish the Release on Github

  • Fast forward master to release

      git checkout master
      git merge --ff-only release/<version>
      git push
  • Merge release branch into develop (if not done yet)

      git checkout develop
      git merge release/<version>
      git push
  • DO NOT delete the release branch. We will keep the release branch to do improvements on the documentation for the just released version (or if ever needed: for hotfixes as well). Because usually short after a release we get feedback about how to improve that version of the docu. Such things have still to be fixed on the release branch and merged both to master and develop, such that those changes are in the published documentation of that version!

  • Create a release on github to make the release publicly visible:
  • For description use the release notes of that release version from in the release description on github.
  • Make sure you safe it first only as a draft and do not publish them yet.
  • Attach the binary of the release (WAR-file having the right clean version number downloaded from CircleCI) to the release notes (see area "Attach binaries by dropping them here ...").
  • Publish the release when done.

Publish the Release as signed WAR on Maven Central

  1. You will need to specify the following properties in your located in your gradle home directory:
signing.password=#private key goes here#
signing.secretKeyRingFile=#secret key file goes here#
ossrhPassword=#sonatype password goes here#
  1. Change the version appropriately in the build.gradle
  2. gradlew clean uploadArchives
  3. Promote build to maven central:

Publish the Release on Webpage, Twitter and Newsletter

  • Update the Webpage (if needed): Merge the prepared changes for the webpage for the release (release branch on repository) to master to update the webpage for the release (if needed)
  • Post on Twitter: Send out a notfication about the new released version on our Twitter news channel: scenarioo_org (Login with our master password)
  • Send out Newsletter to
  • Post it on Yammer and other important news channels

Release Postprocessing

Change following things on develop branch to prepare for further work on further releases:

  • Check documentationVersion in build.gradle is changed to develop again, such that it points to current latest and greatest developer docu, until we do a new release
  • Verify that in docs/book.json the develop version of the docu is marked as selected again and the edit link points to the develop branch again.

results matching ""

    No results matching ""