Difference between revisions of "EDT:How to add new EDT plugins"

From Eclipsepedia

Jump to: navigation, search
Line 2: Line 2:
  
 
#Be sure the new plugin's MANIFEST.MF is correct.  
 
#Be sure the new plugin's MANIFEST.MF is correct.  
#*There should be no warnings on the MANIFEST.MF file.
+
#*There should be no warnings on the MANIFEST.MF file.  
 
#*The ID must begin with '''org.eclipse.edt'''.  
 
#*The ID must begin with '''org.eclipse.edt'''.  
 
#*The Version must be of the form '''0.7.0.qualifier''' (use the correct numbers for the release you're developing).  
 
#*The Version must be of the form '''0.7.0.qualifier''' (use the correct numbers for the release you're developing).  
#*The Provider must be '''Eclipse EGL Development Tools'''.
+
#*The Provider must be '''Eclipse EGL Development Tools'''.  
#*The Execution Environment must be '''JavaSE-1.6'''.
+
#*The Execution Environment must be '''JavaSE-1.6'''.
#*Don't require an exact version of a plugin without good reason.
+
#Specify your dependencies carefully.  
#*Be aware that the build may be done with an older version of Eclipse than you are using.  For example, EDT 0.7.0 is built on Eclipse 3.6.0, even though the latest version of Eclipse 3.6 is 3.6.2.  We do this so EDT will work on every Eclipse 3.6.x release.
+
#*Don't require an exact version of a plugin without a '''very''' good reason.  
#Plugin projects should not set their JDK Compliance.
+
#*Be aware that the build may be done with an older version of Eclipse than you are using.  For example, EDT 0.7.0 is built on Eclipse 3.6.0, even though the latest version of Eclipse 3.6 is 3.6.2.  We do this so EDT will work on every Eclipse 3.6.x release.  
#There should be no warnings on the plugin's build.properties file.
+
#*If the build fails with a "Missing required plug-in" error on your plugin, it probably depends on a plugin from a feature that's not included in the build. The features we require are listed in the featureIDsToInstall property in org.eclipse.edt.releng/build.properties. To learn which feature includes your plugin, go into your eclipse/features directory, and search the feature.xml files in all of the subdirectories for the name of your plugin.
 +
#*do a recursive grep for the plug-in i'm interested in<br>
 +
#Plugin projects should not set their JDK Compliance.  
 +
#There should be no warnings on the plugin's build.properties file.  
 
#Add the plugin project to our CVS repository. Do Team &gt; Share Project &gt; CVS and choose&nbsp;:extssh:you@dev.eclipse.org:/cvsroot/tools. Choose Use Specified Module Name and enter org.eclipse.edt/''folder''/''pluginName''.  
 
#Add the plugin project to our CVS repository. Do Team &gt; Share Project &gt; CVS and choose&nbsp;:extssh:you@dev.eclipse.org:/cvsroot/tools. Choose Use Specified Module Name and enter org.eclipse.edt/''folder''/''pluginName''.  
 
#If the ''folder'' in the previous step is new, update the project metadata. Go to https://dev.eclipse.org/portal/myfoundation/portal/portal.php, click view next to tools.edt, and click maintain next to Project Info Meta-data. Click edit and update the list under "source repository".  
 
#If the ''folder'' in the previous step is new, update the project metadata. Go to https://dev.eclipse.org/portal/myfoundation/portal/portal.php, click view next to tools.edt, and click maintain next to Project Info Meta-data. Click edit and update the list under "source repository".  

Revision as of 10:32, 25 August 2011

To add a new EDT plugin, a committer should do the following.

  1. Be sure the new plugin's MANIFEST.MF is correct.
    • There should be no warnings on the MANIFEST.MF file.
    • The ID must begin with org.eclipse.edt.
    • The Version must be of the form 0.7.0.qualifier (use the correct numbers for the release you're developing).
    • The Provider must be Eclipse EGL Development Tools.
    • The Execution Environment must be JavaSE-1.6.
  2. Specify your dependencies carefully.
    • Don't require an exact version of a plugin without a very good reason.
    • Be aware that the build may be done with an older version of Eclipse than you are using.  For example, EDT 0.7.0 is built on Eclipse 3.6.0, even though the latest version of Eclipse 3.6 is 3.6.2.  We do this so EDT will work on every Eclipse 3.6.x release.
    • If the build fails with a "Missing required plug-in" error on your plugin, it probably depends on a plugin from a feature that's not included in the build. The features we require are listed in the featureIDsToInstall property in org.eclipse.edt.releng/build.properties. To learn which feature includes your plugin, go into your eclipse/features directory, and search the feature.xml files in all of the subdirectories for the name of your plugin.
    • do a recursive grep for the plug-in i'm interested in
  3. Plugin projects should not set their JDK Compliance.
  4. There should be no warnings on the plugin's build.properties file.
  5. Add the plugin project to our CVS repository. Do Team > Share Project > CVS and choose :extssh:you@dev.eclipse.org:/cvsroot/tools. Choose Use Specified Module Name and enter org.eclipse.edt/folder/pluginName.
  6. If the folder in the previous step is new, update the project metadata. Go to https://dev.eclipse.org/portal/myfoundation/portal/portal.php, click view next to tools.edt, and click maintain next to Project Info Meta-data. Click edit and update the list under "source repository".
  7. Add the new plugin to the feature.xml of its feature.
  8. Make an entry in the map file (org.eclipse.edt.releng/maps/edt.map) for the new plugin.
  9. Do Team > Release to get the code into the next build.