Difference between revisions of "Corona/Releng/Build"

From Eclipsepedia

< Corona‎ | Releng
Jump to: navigation, search
(Build prerequisities)
(Build prerequisities)
Line 17: Line 17:
 
* standalone package org.eclipse.releng.basebuilder (the newest version)
 
* standalone package org.eclipse.releng.basebuilder (the newest version)
 
* Web Tools Project all-in-one Eclipse with the following non-standard plugins:
 
* Web Tools Project all-in-one Eclipse with the following non-standard plugins:
** org.eclipse.ecf
+
** org.eclipse.ecf-0.9.1
 
** org.eclipse.equinox.log
 
** org.eclipse.equinox.log
 
** org.eclipse.equinox.event
 
** org.eclipse.equinox.event

Revision as of 06:46, 20 October 2006

Eclipse Home Wiki Home Development

Contents

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 prerequisities

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)
  • Web Tools Project all-in-one Eclipse with the following non-standard plugins:
    • org.eclipse.ecf-0.9.1
    • org.eclipse.equinox.log
    • org.eclipse.equinox.event
    • org.eclipse.equinox.http

Steps Required for Setting Headless Build Platform

Let the directory, in which the build is run, be "build". org.eclipse.releng.basebuilder should be installed in "build/..". The following configuration should be made:

  1. Change build.properties file
    • baseLocation - the directory in which eclipse-SDK is installed
    • base - the directory baseLocation/..
    • ftpServer - IP of ftp server to copy build results
    • ftpUser, ftpPassword, remoteDirectory - connection parameters on the remote server
  2. Change internalBuildTools/testConfigs/linux-local/testing.properties file:
    • testDir - directory where automated testing framework will be installed
  3. Prepare build/../download directory. It should contain all 3rd party libraries in the following configuration: for each plugin requiring the libraries, there should be a directory named: "pluginname"/lib containing the jar files.
  4. Set JAVA_HOME to point at the JDK installation
  5. Change update.eclipse.properties for feed generation
    • branch - the number of branch that is build
    • buildAlias - branch number and name

Setting Configuration for Automated Tests

  1. In order to run automated tests, copy zips of the following plugins into build directory:
    • ecf, eclipse-SDK, eclipse-test-framework, emf-sdo-xsd-SDK
    • additionally, it is required to have equinox.log and equinox.event jars and apache.xerces packed into a zip containing eclipse/plugins sudirectory.

Execution of Build Scripts

The main build script is:

  • buildAll.sh X - X denotes the type of build, that is X = M, I, N, S, runs the build, tests, generates html data and published build results
    1. for example, to execute a maintenace build, call ./buildAll.sh M
  • buildFeed.sh - generates and publishes RSS Feed

Operations Done During Build Phases


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

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