Jump to: navigation, search

Difference between revisions of "Corona/Releng/Build"

< Corona‎ | Releng
(Installation and configuration of headless automated build process for Corona)
Line 7: Line 7:
 
</table>
 
</table>
 
----
 
----
== Installation and configuration of headless automated build process for Corona ==
+
== Installation and Configuration of Automated Build Process for Corona ==
 +
The document describes how to configure and run automated builds of Corona project. The description is intended for Linux platform.
 +
=== Build Environment ===
 
For headless build the infrastructure provided by the PDE and the RelEng (Release Engineering) plugins is needed.
 
For headless build the infrastructure provided by the PDE and the RelEng (Release Engineering) plugins is needed.
To create an environment needed for the build process the seperate org.eclipse.releng.basebuilder plugin is sufficient however the Eclipse SDK can be used as well (Corona requires 3.2 version of Eclipse environment).
+
To set up the build environment it is required to have:
 +
* Java5 visible in PATH
 +
* cvs, zip and unzip visible in PATH
 +
* standalone package org.eclipse.releng.basebuilder (the newest version)
 +
* Eclipse IDE with the following non-standard plugins:
 +
** org.apache.xerces
 +
** org.eclipse.ecf
 +
** org.eclipse.emf
 +
** org.eclipse.equinox.log
 +
** org.eclipse.equinox.event
 +
** org.eclipse.wtp
  
 
== Build prerequisities ==
 
== Build prerequisities ==

Revision as of 09:47, 18 October 2006

Eclipse Home Wiki Home Development

Installation and Configuration of Automated Build Process for Corona

The document describes how to configure and run automated builds of Corona project. The description is intended for Linux platform.

Build Environment

For headless build the infrastructure provided by the PDE and the RelEng (Release Engineering) plugins is needed. To set up the build environment it is required to have:

  • Java5 visible in PATH
  • cvs, zip and unzip visible in PATH
  • standalone package org.eclipse.releng.basebuilder (the newest version)
  • Eclipse IDE with the following non-standard plugins:
    • org.apache.xerces
    • org.eclipse.ecf
    • org.eclipse.emf
    • org.eclipse.equinox.log
    • org.eclipse.equinox.event
    • org.eclipse.wtp

Build prerequisities

Steps required for setting headless build platform

  • download buildCorona.bat for windows platform or buildCorona.sh for linux platform
  • set the following properties from buildCorona.bat/buildCorona.sh to reflect the build environment:
  1. set JAVA_HOME to point at the JDK installation
  2. set eclipseDir to point at the Eclipse installation to be used for the build
  3. set buildType to receive server or/and client Corona distribution, supported values for this property: client, server, full
  • execute the buildCorona.bat/buildCorona.sh file to build Corona project.

Execution of buildCorona script comprises:

  • cleaning previous build output
  • fetching build scripts and properties required by the build process such as:
  1. run.bat/run.sh - scripts starting an Eclipse instance as AntRunner
  2. buildCorona.xml - build script file controling the build sequence
  3. customTargets.xml - build script file enabling customization of the build process, defines the map files to be fetched and the features to be built
  4. build.properties - contains the properties needed for fetching and building the sources
  • executing run.bat/run.sh script

Build Corona Documentation Plugin

To build corona with documentation plugin, following prerequisites are needed.

  • Linux machine.
  • Installed ANT.
  • JAVA_HOME environment variable pointing to Java home directory.
  • ANT_HOME envitonment variable pointing to ANT home directory.
  • Set withJavaDoc property in build.properties file, as follows
 # Default for java doc generation.
 withJavaDoc=true

JavaDoc generation

Corona's JavaDoc will always be generated and integrated within documentation plugin. If you'd like to generate javadoc without documentation plugin, following prerequisites has to be set.

  • LINUX
    • Installed ANT.
    • JAVA_HOME environment variable pointing to Java home directory.
    • ANT_HOME envitonment variable pointing to ANT home directory.
    • Documentation plugin should be on the same level as other corona's plugins

To start generation run script antJavadoc.sh located in org.eclipse.corona.doc\build.

  • WINDOWS
    • Installed cygwin.
    • JAVA_HOME environment variable pointing to Java home directory.
    • ANT_HOME envitonment variable pointing to ANT home directory.
    • Documentation plugin should be on the same level as other corona's plugins

To start generation run under cygwin script antJavadoc.sh located in org.eclipse.corona.doc\build.

Results of successful build process

${buildDirectory}/buildResults directory (buildResults name is a value of buildLabel property defined inside the build.properties) contains zip archive(s) with corona distribution. For 'buildType=full' two archives are created: org.eclipse.corona.client-DEMO.zip and org.eclipse.corona.server-DEMO.zip (DEMO name is a value of buildId property defined inside the build.properties).

Stages of build process

  • preBuild - fetching and concatenating map files (in corona.map dynamic setting of cvs tag name is made on the basis of fetchTag property value defined inside build.properties)
  • fetch - retrieving project resources on the basis of the map files definition
  • generate - generating build scripts for fetched resources
  • process - compiling sources, coping results to build output directory or creating jar files containing the build output
  • assemble - creating zip archive containg all build results

Useful links concerning eclipse build process