|
|
| (7 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| − | Here are the steps for adding a new bundle to Orbit. Please use them as a checklist to ensure that you have done
| + | {{warning|Note: The contents of this page has been migrated. Please see https://github.com/eclipse/orbit/blob/master/Bundle-checklist.md for current information, or page history for historical versions. }} |
| − | 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.
| + | |
| − | | + | |
| − | CQs can be created on the [http://portal.eclipse.org Eclipse Foundation] web site in the portal.
| + | |
| − | | + | |
| − | ===Add the Bundle to Git===
| + | |
| − | In Orbit we store the metadata necessary to generate a bundle in the [http://git.eclipse.org/c/gerrit/orbit/orbit-recipes.git/ orbit-recipes] Git repository. Look at our [[Adding Bundles to Orbit]] document for instructions on how to initially put your bundle into Orbit.
| + | |
| − | | + | |
| − | ===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 <code>releng/aggregationfeature/feature.xml</code> in [http://git.eclipse.org/c/gerrit/orbit/orbit-recipes.git/ orbit-recipes] with an entry for your new bundle. (you don't need one for the source bundle) Changes to the Orbit feature are done in the master branch on Git.
| + | |
| − | | + | |
| − | <plugin id="javax.servlet" version="2.3.0.qualifier" />
| + | |
| − | | + | |
| − | ===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 under <code>src/eclipse/ip_log.xml</code> for a given bundle's module. Generally most of the information should be filled out automatically as part of the creation of the bundle recipes (ebr:create-recipe) but certain information will need to be filled in manually. For example, contact information for the bundle, and the corresponding ipzilla bug id (Add To Orbit CQ Number).
| + | |
| − | | + | |
| − | For more information about the IP Log file, a template and instructions can be found on our [[Orbit IP Log]] wiki page.
| + | |
| − | | + | |
| − | ===Final Notes===
| + | |
| − | * 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.
| + | |
| − | | + | |
| − | ===Example Layout===
| + | |
| − | Here is an example structure for a bundle.
| + | |
| − | | + | |
| − | <pre>
| + | |
| − | my.bundle.id_1.0.0/
| + | |
| − | pom.xml
| + | |
| − | src/
| + | |
| − | eclipse/
| + | |
| − | ip_log.xml
| + | |
| − | main/
| + | |
| − | resources/
| + | |
| − | about.html
| + | |
| − | .project
| + | |
| − | osgi.bnd
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | [[Category:Orbit|Bundle Checklist]]
| + | |
