Skip to main content
Jump to: navigation, search

Difference between revisions of "Swordfish Documentation: Creating Headless Build"

(Eclipse)
(SVN)
Line 30: Line 30:
 
===SVN===
 
===SVN===
  
Install the latest version of the SVN client (currently, the version available is 1.5).<br>
+
Install the latest version of the SVN client (currently, the version available is 1.6.2).<br>
 
You can find the latest version here: [http://subversion.tigris.org Subversion]
 
You can find the latest version here: [http://subversion.tigris.org Subversion]
  

Revision as of 04:47, 18 May 2009

Creating and Running a Headless Build

This section contains instructions on creating a headless build.

Swordfish build process1.png

Prerequisites

The following prerequisites must be met before you start creating the build. You must have the latest version of Eclipse, Apache Ant & Subversion installed. Detailed instructions are provided here.

Eclipse

  1. Install Eclipse SDK
  2. Install the subversion PDE build plugin.
    You can find it here: SVN PDE Build
    NOTE: When making a remote build you need to fetch items (?) from SVN.
    1. Download the zip file, org.eclipse.pde.build.svn-n.n.nRCn.zip.
    2. Unzip the file and extract the contents of the features folder,( org.eclipse.releng.basebuilder/features) and the plugins (org.eclipse.releng.basebuilder.plugin)into the feature directory in your Eclipse installation directory.
  3. Edit the `<used_directory>/org.eclipse.swordfish.build/etc/launcher.properties to set the location of your Eclipse installation.
  4. NOTE: The default value is to set it to the same level.

Ant

Install the latest Ant build (currently, the version available is 1.7) and include it into your path.
You can find the latest version here: Apache Ant

SVN

Install the latest version of the SVN client (currently, the version available is 1.6.2).
You can find the latest version here: Subversion

About the Build Process

The build process is divided into two main stages. This is done for performance reasons. The first stage involves the following steps:

  1. Generate the third-party bundles
  2. Create an update site and store these bundles there.
  3. Upload the update site into the Swordfish download area

NOTE: The last step only needs to be done when changes occur. For example, when you create a new bundle, remove an obsolete bundle or create a new bundle version.

The second stage involves the following steps:

  1. Create the Swordfish site.
  2. Create the corresponding Swordfish update site.

You also need to ensure that your SVN client is enabled to access the Swordfish Repository via your proxy.

Creating a Third-Party Build

This is the first stage of the Swordfish build process, that is, creating the third-party builds.

First Stage

To successfully create and run the third-party build:

  1. Check out the following projects from the Swordfish SVN Swordfish SVN + version-to check-out, for example, trunk.
    • org.eclipse.swordfish.build
    • org.eclipse.swordfish.bundles
    • org.eclipse.swordfish.third-parties/org.eclipse.swordfish.third-parties.site
  2. Switch to the directory <Swordfish project root directory>/org.eclipse.swordfish.build
  3. Start the ant script to run the build.
  4. Check the build results in org.eclipse.swordfish.build/target-third-parties.

NOTE: The build results consist of the update site for Swordfish third-parties. It is located in the site sub-directory.

Creating the Swordfish Headless Build

This is the second stage of the Swordfish build process, that is, creating the Swordfish build and update site. Second Stage
To successfully create and run the Swordfish build:

  1. Check out the following projects from the Swordfish SVN Swordfish SVN
    • org.eclipse.swordfish.build
    • org.eclipse.swordfish.bundles
    • org.eclipse.swordfish.third-parties.site
  2. Switch to the directory <Swordfish project root directory>/org.eclipse.swordfish.build
  3. Start the ant script to run the build.
  4. Check the build results:
    • Browse to the directory org.eclipse.swordfish.build/target
    • Locate the zip file, org.eclipse.swordfish.zip

    NOTE: The zip file, org.eclipse.swordfish.zip contains the newly built feature and plug-ins. The site sub-directory contains the update site for Swordfish.

Creating a Local Build

You can also make a local build. Before creating a third party build the following tasks must first be completed.
To prepare for a local build creation, first:

  1. Create and run a third-party build.
  2. Check the build results.
  3. Check out all the required projects from SVN

To create the local build:

  1. Start the Apache ant build scripts
  2. In the script set the property for the parameter local to true.

  3. For example:
    ant -Dlocal=true

    You can also specify the property in your launcher.properties file.

Check Proxy Settings

If you want to run the build scripts within a firewall, ensure that you enable the proxy settings. For example, add the -autoproxy parameter when you run the ant scripts.
NOTE: The ant scripts use your default system proxy settings.

You also need to ensure that your SVN client is enabled to access the Swordfish Repository via your proxy.




Swordfish Documentation Home
Swordfish Wiki Home

Back to the top