This document guides you through the steps needed for releasing a new version of KIELER.
You will need a terminal application and a user account on the RTSYS servers.
To release a new version of KIELER, please follow these steps:
Increase plug-in version numbers. This applies to all plug-ins that have been part of the previous release in their
pom.xml files. To that end, take a look at the changes performed on each one of them since then. For the moment, we'll leave the major version number (the first number) alone. If there have been breaking API changes (a method added to or removed from a public interface, changed public method signatures, removed public methods, that sort of thing), you will want to increase the minor version number (the second number). If there were any changes that didn't break the API, increase the revision number (the third number). There is one other case for changing the minor version number: if an important dependency has changed. For instance, regenerating Xtend-based code with a new version of Xtend will justify increasing the minor version number. If the dependency only concerns a KIELER component, however, increasing the revision number will suffice. In such cases, we just assume that users will update the plugin on which we depend anyway.
TODO: Document how to download the most recent release update site, set that as the baseline API in Eclipse and activate the API Tools Setup to be able to update versions.
By the way, this is a good time to make sure that every plugin has a proper license file and proper metadata. Go check the nightly RCA build to make sure that plugin names and provider names are set correctly. Also, you may want to write down for every plugin which part of its version number was incremented – that will make the next step way easier.
pom.xmlfiles. The concrete part of the version number to be increased depends on the version number increases of plug-ins included in the feature.
kieler.product(part of the
kwebs.product(part of the
kwebs.serverplugin). Open both inside Eclipse and update the version numbers of the features they include, if one of them is to be released. Also, update the version numbers of the products themselves and don't forget to synchronize the changes (there's a button on the Overview page of the product configuration editor). Once you're finished, the product files have to be made available to the build system. Copy
build/de.cau.cs.kieler.kwebs.repository. If the contents of the product icon folders have changed, these changes have to be made available to the build system as well by copying them appropriately.
category.xmlfiles in the KIELER and KWebS update site folders (
build/de.cau.cs.kwebs.repository, respectively). Take this opportunity to also adapt the update site category names to include the proper version number of the new release.
feature.xmlfile and is best done through mass search & replace. Also, the repository build folders (for instance,
build/de.cau.cs.kieler.pragmatics.repository) generate an
index.htmlfile for the update sites they are generating. Change the update site metadata in the corresponding
pom.xmlby updating the update site version and the update site description (released update sites should have "Release" as their description, nightly build update sites should have "Nightly Build" as their description). Also update the update site version in the master branch.
compositeContent.xml. These two files are in
/home/kieler/public_html/files. Take care to rename the files appropriately: the nightly build files don't include version information, but only a timestamp.
To release a new version of the KIELER Semantics features and product, please follow these steps:
Set version numbers. Since 0.12.0 the semantics plugins and features no longer have individual version numbers. Instead all plugins share the version of the corresponding release.
To set the version number in all pom files, manifests of all plugins and features, including their references in other files run the following script located in build/scripts/ in the semantics repository:
python version.py x.x.x
By the way, this is a good time to make sure that every plugin has a proper license file and proper metadata. Go check the nightly RCA build to make sure that plugin names and provider names are set correctly.
Check if all plug-ins to be released are contained in a feature. This is particularly important for new plug-ins.
Your can use the sanity check script to check the feature containment:
Update the splash screen with the new version number. Adjust the version number in the splash.svg in plugins/de.cau.cs.kieler.core.product/images. Export to splash.bmp (no alpha channel!) in the plugin root folder.
Hints for splash screen adjustments:
Configure the build files in the repository. The build instruction in the repository must be configured for the release build. To apply the configuration run the following script located in build/scripts/:
python configure.py -release x.x.x
This script is also capable of configuring the repository for a nightly build, to force correct configuration or revert effects of a release cofiguation.
Tell Bamboo to build the release. Configure the build plan of the last release to build the new one. Change the following settings:
compositeContent.xml. These two files are in