Building Rodin Headless

This page documents the procedure followed for building the binary packages of the Rodin platform that are distributed on SourceForge. The build is done in two steps

1. Fetch the sources from the repository and make a source archive with them.
2. Build the platform headless from this set of sources using Apache Ant.

Requirements

• Apache Maven 3 should be installed on the platform that will run the build.

Pre Build Verifications

Before building, several checks have to be made in the sources:

• clean build all RodinCore plug-ins, so that generated files are regenerated using repository sources
• JUnit tests are OK
• versions of plug-ins, features and product obey Eclipse versioning policy
• API Tooling build against previous Rodin release produces no errors on any plug-in
• Rodin build process is managed using Apache maven and Tycho. One should verify that maven artifact versions match the plug-in versions (defined in plug-in MANIFEST.MF files)
• the correct Eclipse version is referenced in the p2 configuration (org.rodinp.platform/Rodin.p2.inf)

      addRepository(type:0,location:http${#58}//download.eclipse.org/releases/neon,name:Neon Update Site);\
      addRepository(type:1,location:http${#58}//download.eclipse.org/releases/neon,name:Neon Update Site);\

and matches the one defined whithin the parent pom file (org.eventb.parent/pom.xml) :

	<repository>
		<id>oxygen-4.7</id>
		<layout>p2</layout>
		<url>http://download.eclipse.org/eclipse/updates/4.7/</url>
	</repository>
	

• the correct link for the Rodin Handbook is provided in the parent pom file (org.eventb.parent/pom.xml) :

<repository>
	<id>handbook</id>
	<layout>p2</layout>
	<url>http://handbook.event-b.org/updatesite</url>
</repository>

• branding plug-ins display the correct Eclipse version (text information found in several about.properties/plugin.properties files)
• documentation is up to date for /org.rodinp.platform/html/root.html
• generated documentation matches latest wiki sources for org.eventb.keyboard/doc
• make sure a valid destination folder is specified in org.eventb.parent/pom.xml. This destination folder will host the built platforms, the update-site and the development target platform.

Example :

<www-basedir>/tmp/rodin-build/rodin-3.0</www-basedir>

The variable used in Maven scripts is then ${www-basedir}

When everything works, any changes to the sources made during this verification process are pushed to the Source Forge repository.

N.B. Several information are defined and manipulated for each build. Here below is a memo to help understand them :

1. the platform version which defines a milestone identifier for the Rodin platform. Example of platform versions are 1.0 and 2.3RC1.
2. the Git commit number which permits to know very precisely which source versions are used for the build.
3. the Git branch from which the commit can be checked out
4. the full platform version used for provisioning, and which is the user-visible version which is displayed in About Rodin Platform. This version is made of the platform version and the commit number, separated by a dot. Example of full versions are 2.8RC1.bh1420 and 2.8.1.hgf52f65.

Fetching Sources

Create a directory that will contain the sources and be used to build the platform.
Example :

mkdir Rodin3.0BuildDirectory

and go to this directory :

cd Rodin3.0BuildDirectory

Fetch sources from Git in the current directory :

git clone git://git.code.sf.net/p/rodin-b-sharp/rodincore .

Building the Platform

To build the platform, you just need to run the script below (available from org.rodinp.releng/scripts/run-maven.sh) :

 #!/bin/sh
###############################################################################
# Copyright (c) 2013 Systerel and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html
# 
# Contributors:
#     Systerel - initial API and implementation
###############################################################################
SCRIPT=`readlink -m -n $0`
SCRIPTS_DIR=`dirname $SCRIPT`
MAIN_DIR=`readlink -m -n $SCRIPTS_DIR/../..`
 
cd $MAIN_DIR

GIT_COMMIT=`git log -1 --format='%h'`
echo "Building Rodin with Maven for git commit: $GIT_COMMIT"
mvn clean install -Dgit-commit=$GIT_COMMIT $@ # -DskipTests -fae 

Post Build Verifications

When the build worked, the destination directory (defined by variable ${www-basedir}) contains zipped archives for all platforms, the update site, and the target platform for plug-in development. For each of them, check that:

• "rodin" binary is an executable file (for Linux and Mac)
• the version appearing in About Rodin platform is correctly defined
• a directory "dropins" exists at the root (under "rodin", among "features", plugins", ...)
• in "configuration/org.eclipse.equinox.simpleconfigurator/bundles.info", plug-in "org.eclipse.equinox.p2.reconciler.dropins" is configured with auto start mode ("true" at the end of the line)

Last operations to perform

• Copy the build update site into a dedicated folder onto SourceForge (e.g., /home/pfs/project/rodin-b-sharp/Core_Update_Site/3.5/)
• Ensure that the download of the uploaded version of Rodin is here by default
• Update the main wiki page:
  • http://wiki.event-b.org/index.php/Main_Page
  • The image "out now" is to be changed
  • The link "learn more" should point to the release notes
  • The link "download now" should point to the SF repository
• The Platform releases page should be updated:
  • http://wiki.event-b.org/index.php/Rodin_Platform_Releases
• The 64 bits page should be updated:
  • http://wiki.event-b.org/index.php/Rodin_64_bit
• In the Bug and Feature Request trackers, complete the milestone for the new release, create a new milestone for the following one, and move any remaining ticket between these two milestones.
• A mail is sent on the user + announce rodin SF lists.