Fetching from Repositories

The infrastructure offered by PDE Build provides steps to fetch the source code to build from a repository as part of the build process. Two possibilities are available: let PDE build automatically fetch the source, or fetch the source code manually.

Automated source code fetching from CVS

Given the identifier of a feature that needs to be built, the build infrastructure is able to fetch from CVS all the included features and plug-ins.

In order to know where to get things from, PDE uses map files. A map file is a java property file which maps feature and plug-in ids to a location and a tag in a repository. The format of a map file entry for fetching from CVS is:

<elementType>@<elementID> = CVS, <TAG>, <CVSROOT>[,<PASSWORD>[,<PATH>[,<CVSPASSFILE>]]]

where elementType is one of bundle, feature, plug-in or fragment.  If the path is not specified then the element name will be used as CVS module instead, for example: 

plugin@org.foo.bar=CVS,v20060501,:pserver:anonymous@cvs.example.org:/cvsroot/foo

will fetch the plug-in org.foo.bar that has been labeled with the tag v20060501 from cvs.eclipse.org/cvsroot/foo/org.foo.bar

Setting up for CVS source fetching

To set up fetching your source from CVS, you should do the following:

Getting the map files from CVS

Map files are usually stored in a repository. PDE Build offers default infrastructure to get those map files from a CVS repository. To enable this function change the following properties in your configuration's build.properties from your configuration directory: Fetching the map files from CVS occurs during the Pre-Build phase of the build.  Scripts to fetch all the features and plug-ins included in the feature you are building will be generated and run during the fetch phase of the build. 

Automatic fetching from other repositories

PDE Build provides an extension point where fetch script generators for different repositories can be plugged in.  When your eclipse install contains a bundle that provides a script generator extension for a different type of repository, you can use that repository by specifying it in your map file entries:  

<elementType>@<elementID> = <REPOSITORY>, <TAG>, [...] 

The format of the map entry after the TAG will depend on the extension.

If  you are automatically fetching your map files from the repository, you will need to copy the customTarget.xml file from org.eclipse.pde.build/templates/headless-build into your configuration directory.  The target  getMapFiles is used to fetch the map files, this should be modified to fetch from your repository.

Getting source code manually

You can write custom fetch targets to retrieve your plug-ins and features which can be invoked from the preSetup or postSetup targets in the customTargets.xml file.  Features and plug-ins should be fetched to ${buildDirectory}/features and ${buildDirectory}/plugins respectively.