Jump to: navigation, search

Orbit/Bundle Checklist

< Orbit
Revision as of 15:34, 27 February 2008 by Dj houghton.ca.ibm.com (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Bundle Checklist

Here are the steps for adding a new bundle to Orbit. Please use them as a checklist to ensure that you have done everything correctly when you have a new bundle to add.

CQs

A CQ is a Contribution Questionnaire and it basically refers to legal approval to use a third party bundle in Eclipse. Every bundle in Orbit needs to have at least 2 CQs, one for the bundle being in the Eclipse repository (being a part of Orbit), and then one for each of the projects which are going to be using the Orbit bundle. These subsequent CQs can be created as "piggy-back" CQs which are commonly easier to clear legal since the code has already been approved and you just want permission to re-use it.

Add the Bundle to CVS

Create a Source Bundle

If you have source for your bundle, then follow these steps for getting your bundle into the right format to be consumed by the build.

  • In your bundle root, create a directory called source-bundle
  • Add the appropriate about.html file and an about_files directory with the licenses.
  • Modify the bundle manifest to add the line to say that your source bundle is attached to the main bundle.
Eclipse-SourceBundle: my.bundle.id;version="1.0.0.qualifier"
  • Extract the source.
  • Modify the build.properties to ensure the root of the source is included in the build. (in the case

below, the my/ directory is the root of the source since it is for the bundle my.bundle.id.

bin.includes = about.html,\
               about_files/,\
               plugin.properties,\
               META-INF/,\
               my/

Update the Feature

In an Eclipse build, we build features so when we add a new bundle to Orbit, we must add it to the feature so the builder is aware that we should build it. Please update org.eclipse.orbit.feature.set1/feature.xml with an entry for your new bundle. (you don't need one for the source bundle)

<plugin
	id="my.bundle.id"
	download-size="0"
	install-size="0"
	version="1.0.0.qualifier"
	unpack="false"/>

Update the Map File

In Eclipse, the build contributions are driven from map files which specify your bundle, version, and location in the repository. In Orbit our map file is stored in org.eclipse.orbit.releng/maps/bundles.map. When you add a new bundle to the build, you must add an entry for your source bundle to the bundles.map file. Don't forget to add an entry for the source bundle if you created one.

plugin@my.bundle.id,1.0.0=v200802271055,:pserver:anonymous@dev.eclipse.org:/cvsroot/tools,,org.eclipse.orbit/my.bundle.id
plugin@my.bundle.id.source,1.0.0=v200802271055,:pserver:anonymous@dev.eclipse.org:/cvsroot/tools,,org.eclipse.orbit/my.bundle.id/source-bundle

Update the Project Set File

<project reference="1.0,:extssh:dev.eclipse.org:/cvsroot/tools,org.eclipse.orbit/my.bundle.id,my.bundle.id_v1.0.0,v1_0_0"/>

Update the IP Log