Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Corona HowTo: Include a New Plugin in Build"
(→Modify Build) |
|||
Line 1: | Line 1: | ||
− | + | =Correct Plugin Structure= | |
− | + | ||
− | =Plugin Structure= | + | |
A Corona plugin is a regular Equinox plugin/fragment that conforms to Europa build practices. If a new plugin is created the following should be assured: | A Corona plugin is a regular Equinox plugin/fragment that conforms to Europa build practices. If a new plugin is created the following should be assured: | ||
− | * 4-part version numbering should be used, the first three parts are numbers, the last is "qualifier" word, for example: 0.5.0.qualifier | + | * 4-part version numbering should be used, the first three parts are numbers, the last is "qualifier" word, for example: 0.5.0.qualifier. The "qualifier" is not used for plugins representing 3rd party. |
* plugin must correctly list its required JVM versions in the manifest/plugin.xml | * plugin must correctly list its required JVM versions in the manifest/plugin.xml | ||
− | * build.properties file must list all files that should be included in the build result (the option bin.includes) | + | * build.properties file must list all files that should be included in the build result (the option bin.includes), if a jar file is included in Corona, but does not have IP approval, it should be excluded from build.properties. |
=Modify Build= | =Modify Build= | ||
Line 23: | Line 21: | ||
=Check if the Automated build works= | =Check if the Automated build works= | ||
− | Verify if the currently configured build works correctly. | + | Verify if the currently configured build works correctly. The page [[Corona_Development_Build|Execution_of_Build_Scripts]] |
The page [[Corona_Development_Build]] describes steps to set up a new build environment or adjust existing one. | The page [[Corona_Development_Build]] describes steps to set up a new build environment or adjust existing one. |
Revision as of 11:46, 18 December 2006
Correct Plugin Structure
A Corona plugin is a regular Equinox plugin/fragment that conforms to Europa build practices. If a new plugin is created the following should be assured:
- 4-part version numbering should be used, the first three parts are numbers, the last is "qualifier" word, for example: 0.5.0.qualifier. The "qualifier" is not used for plugins representing 3rd party.
- plugin must correctly list its required JVM versions in the manifest/plugin.xml
- build.properties file must list all files that should be included in the build result (the option bin.includes), if a jar file is included in Corona, but does not have IP approval, it should be excluded from build.properties.
Modify Build
The following steps should be taken to include a new plugin in build:
- add the plugin to Corona Client and/or Server feature (steps for adding to Corona client feature)
- open org.eclipse.corona.client
- open feature.xml
- on Plug-ins and fragments tab select Add and select the new plugin
- then select Versions and select Synchronization options: "Copy versions from plug-in and fragment manifests"
- save the feature.xml and commit to CVS
- modify Corona maps for Corona client and/or server
- the maps can be found in maps folder in CVS under org.eclipse.corona
- add a line that represents the plugin, the line must specify plugin/fragment, name and CVS access parameters analogously to other defined entries in maps.
- If milestone version or 3rd party jars change it is necessary to modify files in the build folder (the folder is in Corona CVS)
- in customTargets.xml modify getPlugins target, set the correct argument to wget of 3rd party jars OR
- assure that download folder on the build machine contains a file named build.zip with all necessary 3rd party plugins and jars.
Check if the Automated build works
Verify if the currently configured build works correctly. The page Execution_of_Build_Scripts
The page Corona_Development_Build describes steps to set up a new build environment or adjust existing one.