Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Latest commit

 

History

History
82 lines (56 loc) · 3.83 KB

build.adoc

File metadata and controls

82 lines (56 loc) · 3.83 KB

This page describes how to build the Apache IvyDE plugin from the source. The build is based on the Eclipse™ build system so it requires an Eclipse installation. You also need to have an Ivy bundle installed.

Setup of the build

Eclipse installation

First, you need an Eclipse installation which contains the PDE plugins (e.g., an Eclipse SDK). We will refer to the Eclipse installation path in the documentation as $ECLIPSE_HOME. In that $ECLIPSE_HOME folder you should have the plugins and features folders.

It is recommended to have an Eclipse installation dedicated to the build. So you will be able to have better control over the Ivy bundle installed there. And as the build cleans the internal cache of Eclipse, running an Eclipse and building with the same instance might cause some troubleshooting in the IDE.

Lots of Ant targets depend on that Eclipse installation, so they need a baseLocation property to be defined. Note that you can avoid specifying that property in each command line by having a local.build.properties file which contains something like:

baseLocation=/home/me/tools/eclipse-4.3

An Ant target is provided to download all the necessary binaries, just like the CI is running: ant download-eclipse. No need to specify a baseLocation in the property file to use that downloaded Eclipse and plugins.

The Apache Ivy bundle

The IvyDE plugins depends on the Apache Ivy 2.0 OSGi bundle. So the Ivy bundle has to be installed in the Eclipse installation before starting the build. An Ant target will accomplish that automatically. Inline help will be displayed when no property is specified:

ant install-ivy

Note: due to an old bug in the build script of Ivy, the OSGi version of Ivy is "0.0.0" for every version older than the 2.0.0-RC1. So versions older than 2.0.0-RC1 are not supported.

Building

First somehow you get the source code, for instance from the ASF Git repository:

git clone https://git.apache.org/ant-ivyde.git ivyde

or use the released source code directly from the distribution.

Then, go into the root directory of the sources. In that directory you should see the builder, org.apache.ivyde.eclipse and org.apache.ivyde.feature subdirectories.

And run the build:

ant build -DbaseLocation=$ECLIPSE_HOME

Then in the created directory work you will find a subdirectory (something like 2.0.0.alpha1-200804171513) in which you will find the zip archive ready to be unzipped in an Eclipse installation.

Install

After a successful build you should have a zip file at dist/org.apache.ivyde.feature-$VERSION.zip. The zip file contains the plugins and features directories ready to be unzipped in an Eclipse installation. So here is the process:

cd $ECLIPSE_HOME/dropins
unzip ...../dist/org.apache.ivyde.feature-$VERSION.zip

Then start your Eclipse and enjoy !