Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Orbit/Bundle Checklist"
(→Update the Feature) |
|||
| (19 intermediate revisions by 5 users not shown) | |||
| Line 3: | Line 3: | ||
===CQs=== | ===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 | + | 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 either a CQ, or reference to ClearlyDefined indicating an appropriate score for the third party library. |
CQs can be created on the [http://portal.eclipse.org Eclipse Foundation] web site in the portal. | CQs can be created on the [http://portal.eclipse.org Eclipse Foundation] web site in the portal. | ||
| − | + | [https://clearlydefined.io/ ClearlyDefined] can also be used. | |
| − | + | ||
| − | === | + | ===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. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ===Verify the osgi.bnd === | |
| − | + | The osgi.bnd file is used to generate the bundle manifest (<code>META-INF/MANIFEST.MF</code>), and while this file gets generated with some defaults, it is very important to verify it as well as the contents of the generated manifest to ensure the final result is what one expects. In particular the <code>Import-Package</code> header patterns should be verified. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
===Update the Feature=== | ===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> | + | 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 [https://git.eclipse.org/c/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=== | ===Final Notes=== | ||
| Line 73: | Line 30: | ||
===Example Layout=== | ===Example Layout=== | ||
| + | Here is an example structure for a bundle. | ||
| + | |||
<pre> | <pre> | ||
| − | my.bundle. | + | my.bundle.id_1.0.0/ |
| − | + | pom.xml | |
| − | + | src/ | |
| − | + | eclipse/ip_log.xml | |
| − | + | main/resources/ | |
| − | + | about_files/LICENSE.txt | |
| − | + | about.html | |
| − | + | .project | |
| − | + | osgi.bnd | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</pre> | </pre> | ||
| + | |||
| + | [[Category:Orbit|Bundle Checklist]] | ||
Revision as of 15:25, 31 December 2020
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.
Contents
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 either a CQ, or reference to ClearlyDefined indicating an appropriate score for the third party library.
CQs can be created on the Eclipse Foundation web site in the portal.
ClearlyDefined can also be used.
Add the Bundle to Git
In Orbit we store the metadata necessary to generate a bundle in the orbit-recipes Git repository. Look at our Adding Bundles to Orbit document for instructions on how to initially put your bundle into Orbit.
Verify the osgi.bnd
The osgi.bnd file is used to generate the bundle manifest (META-INF/MANIFEST.MF), and while this file gets generated with some defaults, it is very important to verify it as well as the contents of the generated manifest to ensure the final result is what one expects. In particular the Import-Package header patterns should be verified.
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 releng/aggregationfeature/feature.xml in 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 src/eclipse/ip_log.xml 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.
my.bundle.id_1.0.0/
pom.xml
src/
eclipse/ip_log.xml
main/resources/
about_files/LICENSE.txt
about.html
.project
osgi.bnd