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.
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.
CQs can be created on the Eclipse Foundation web site in the portal.
Add the Bundle to CVS
In Orbit we store bundle versions in branches in CVS. Look at our Adding Bundles to Orbit document for instructions on how to initially put your bundle into Orbit.
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. This page also describes Orbit Source Bundles.
Note: if you have a more complicated bundle which has multiple JARs and multiple source roots for these JARs, then you will have to do more work. Check out this wiki page section to learn how to specify multiple source roots.
Note: We want to have the source files be exactly as we found them so therefore when you release them to CVS, set the type to be ASCII-ko so we don't get any keyword substitution when checking them out.
- In your bundle root, create a directory called
- Add the appropriate
about.htmlfile and an
about_filesdirectory with the licenses.
- Modify the bundle manifest to remove the unnecessary headers and add the line to say that your source bundle is attached to the main bundle. It should look like:
Manifest-Version: 1.0 Bundle-Name: %pluginName Bundle-Vendor: %providerName Bundle-Localization: plugin Bundle-Version: 1.0.0.qualifier Bundle-ManifestVersion: 2 Bundle-SymbolicName: my.bundle.id.source Eclipse-SourceBundle: my.bundle.id;version="1.0.0.qualifier"
- Extract the source to the root of the directory.
- Modify the
build.propertiesto ensure the root of the source is included in the build.
In the example below, the
my/ directory is the root of the source since it is for the bundle
my.bundle.id. The bundle also contains legal files in an
about_files directory so it is included here.
bin.includes = about.html,\ about_files/,\ plugin.properties,\ META-INF/,\ my/
Update the Feature
In Eclipse 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.build.feature.set1/feature.xml with an entry for your new bundle. (you don't need one for the source bundle) Changes to the Orbit feature are done in HEAD in CVS.
<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 in HEAD in CVS.
When you add a new bundle to the build, you must add an entry for your bundle to the
bundles.map file. Don't forget to add an entry for the source bundle if you created one. You must tag your projects (Team -> Tag as Version, timestamp in UTC) and also the feature if you changed it, and then update the map file.
firstname.lastname@example.org,1.0.0=v200802271055,:pserver:email@example.com:/cvsroot/tools,,org.eclipse.orbit/my.bundle.id firstname.lastname@example.org,1.0.0=v200802271055,:pserver:email@example.com:/cvsroot/tools,,org.eclipse.orbit/my.bundle.id/source-bundle ... firstname.lastname@example.org=v200802271055,:pserver:email@example.com:/cvsroot/tools,,org.eclipse.orbit/org.eclipse.orbit.build.feature.set1
Update the Project Set File
We keep a project set file in HEAD to keep track of the list of bundles that we have in Orbit. It can be found here:
org.eclipse.orbit.releng/psf/orbit.psf. We always add a version number to the name of the project that we are checking out, so we handle multiple project versions. Also ensure that you are specifying the correct stream to check out the project from.
Update the IP Log
In Orbit we keep an on-going IP Log to make it easier when it comes to release review time. By keeping this log all the information is always up-to-date and readily available on the web. IP Log files are stored in HEAD in
org.eclipse.orbit.releng/ip_logs and a template and instructions can be found on our Orbit IP Log wiki page.
- When in doubt, look at the other bundles in Orbit to see what they did.
- Always check the build output to ensure that it is what you expect.
Here is an example structure for a bundle which contains a nested source bundle.
my.bundle.id/ about_files/ META-INF/MANIFEST.MF my/bundle/id/Main.class source-bundle/ about_files/ META-INF/MANIFEST.MF my/bundle/id/Main.java about.html build.properties plugin.properties about.html build.properties plugin.properties