Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Swordfish Documentation: Creating Headless Build
Contents
Creating and Running a Headless Build
This section contains instructions on creating a headless build.
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
- Install Eclipse SDK
- 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. - Download the zip file, org.eclipse.pde.build.svn-n.n.nRCn.zip.
- 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.
- Extract the contents of the zip file, org.eclipse.releng.basebuilder/features
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.5).
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:
- Generate the third-party bundles
- Create an update site and store these bundles there.
- 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:
- Create the Swordfish site.
- 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:
- 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
- Switch to the directory <Swordfish project root directory>/org.eclipse.swordfish.build
- Start the ant script to run the build.
- 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 a Swordfish Headless Build
To successfully create and run the Swordfish build:
- 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
- Switch to the directory <Swordfish project root directory>/org.eclipse.swordfish.build
- Start the ant script to run the build.
- 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:
- Create and run a third-party build.
- Check the build results.
- Check out all the required projects from SVN
To create the local build:
- Start the Apache ant build scripts
- In the script set the property for the parameter local to true.
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.