Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Eclipse/Release checklist"

m
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
This checklist is used by the [[Eclipse]] top-level project in preparing its releases.
 +
 
<ol>
 
<ol>
 
   <li><b>Copyright notices</b>
 
   <li><b>Copyright notices</b>
 
     <ul>
 
     <ul>
 
       <li>All source files must have appropriate EPL v1.0 copyright notice</li>
 
       <li>All source files must have appropriate EPL v1.0 copyright notice</li>
       <li>Source files whose content was created for 3.3 should read &quot;Copyright  
+
       <li>Source files whose content was created in this release should read
        (c)&nbsp; 2007 ...&quot;</li>
+
      &quot;Copyright (c)&nbsp; 2011 ...&quot; or &quot;Copyright (c)&nbsp; 2012 ...&quot;</li>
       <li>Source files whose content was modified during 3.3 cycle should read  
+
       <li>Source files whose content was modified during this release should read  
         &quot;Copyright (c)&nbsp; 200x, 2007 ...&quot;</li>
+
         &quot;Copyright (c)&nbsp; 200x, 2011 ...&quot; or &quot;Copyright (c)&nbsp; 200x, 2012 ...&quot;</li>
 
       <li>All features should have &quot;(c) Copyright Eclipse contributors and  
 
       <li>All features should have &quot;(c) Copyright Eclipse contributors and  
         others 2000, 2007.&quot; in Help &gt; About Eclipse Platform</li>
+
         others 2000, 2012.&quot; in Help &gt; About Eclipse SDK</li>
       <li><strike>Also, splash screen copyright needs to be updated, see  [https://bugs.eclipse.org/bugs/show_bug.cgi?id=184622 bug 184622]</strike>
+
       <li>Splash screen copyright needs to be updated</li>
      <li>3.3.2 splash screen copyright needs to be updated see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=215349 bug 184622]</li>
+
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
   <li><b>Plug-in and feature identification</b>
+
   <li><b>Plug-in and feature identification</b> [Dani]
 
     <ul>
 
     <ul>
       <li>Check this info from Help &gt; About Eclipse SDK</li>
+
       <li>Check the info in Help &gt; About Eclipse SDK</li>
 
       <li>All features should have provider &quot;Eclipse.org&quot; and a version that adheres to the
 
       <li>All features should have provider &quot;Eclipse.org&quot; and a version that adheres to the
 
[[Version_Numbering_Europa_Update | Versioning guidelines]]  
 
[[Version_Numbering_Europa_Update | Versioning guidelines]]  
Line 21: Line 22:
 
         </li>
 
         </li>
 
       <li>All plug-ins should have provider &quot;Eclipse.org&quot; and version
 
       <li>All plug-ins should have provider &quot;Eclipse.org&quot; and version
[[Version_Numbering_Europa_Update | Versioning guidelines]] . except for known special cases (org.apache.*,
+
[[Version_Numbering_Europa_Update | Versioning guidelines]], except for known special cases (org.apache.*,
 
         org.junit, and bundles from Orbit).</li>
 
         org.junit, and bundles from Orbit).</li>
        <li>Compare release build with last release 3.2.2 using the version compare tool.</li>
 
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
   <li><b>License agreements for features and plug-ins</b>
+
   <li><b>License agreements for features and plug-ins</b> [Dani]
 
     <ul>
 
     <ul>
 
       <li>Help &gt; About Eclipse SDK &gt; {Feature | Plug-in} Details &gt;
 
       <li>Help &gt; About Eclipse SDK &gt; {Feature | Plug-in} Details &gt;
 
         More Info</li>
 
         More Info</li>
       <li>All features should link to the Eclipse Foundation Software User Agreement  
+
       <li>All features should link to the Eclipse Foundation Software User Agreement dated February 1, 2011</li>
        dated Mar. 17, 2005</li>
+
       <li>All plug-ins should link to the plug-in's about.html file containing its plug-in-specific license</li>
       <li>All plug-ins should link to the plug-in's about.html file containing
+
        its plug-in-specific license</li>
+
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
Line 40: Line 38:
 
       <li>Extension points must be documented in the appropriate help book
 
       <li>Extension points must be documented in the appropriate help book
 
         <ul>
 
         <ul>
           <li>Platform Plug-in Developer Guide; section Reference / Extension
+
           <li>Platform Plug-in Developer Guide; section Reference / Extension Points Reference</li>
            Points Reference</li>
+
           <li>JDT Plug-in Developer Guide; section Reference / Extension Points Reference</li>
           <li>JDT Plug-in Developer Guide; section Reference / Extension Points
+
            Reference</li>
+
 
           <li>PDE Guide; section Reference / Extension Points Reference</li>
 
           <li>PDE Guide; section Reference / Extension Points Reference</li>
 
         </ul>
 
         </ul>
 
       </li>
 
       </li>
 
       <li>Must be a link to each extension point that a component has</li>
 
       <li>Must be a link to each extension point that a component has</li>
       <li>Extension points added in 3.3 must be clearly marked &quot;Since
+
       <li>Extension points added in this release must be clearly marked &quot;Since
         3.3&quot;</li>
+
         x.y&quot; where x.y is the project release number</li>
 +
      <li>See also [[Eclipse_Doc_Checklist#ISV_Documentation | ISV doc checklist]]</li>
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
Line 56: Line 53:
 
       <li>Java API must be documented in the appropriate help book
 
       <li>Java API must be documented in the appropriate help book
 
         <ul>
 
         <ul>
           <li>Platform Plug-in Developer Guide; section Reference / API
+
           <li>Platform Plug-in Developer Guide; section Reference / API Reference</li>
            Reference</li>
+
 
           <li>JDT Plug-in Developer Guide; section Reference / API Reference</li>
 
           <li>JDT Plug-in Developer Guide; section Reference / API Reference</li>
 
           <li>PDE Guide; section Reference / API Reference</li>
 
           <li>PDE Guide; section Reference / API Reference</li>
Line 65: Line 61:
 
       <li>API package must have package overview (package.html)</li>
 
       <li>API package must have package overview (package.html)</li>
 
       <li>All API elements must be documented</li>
 
       <li>All API elements must be documented</li>
       <li>API elements added in 3.3 must be tagged &quot;@since 3.3&quot;</li>
+
       <li>API elements added in this release must be tagged &quot;@since x.y&quot; where x.y is the bundle version number</li>
 +
      <li>See also [[Eclipse_Doc_Checklist#ISV_Documentation | ISV doc checklist]] and [[Eclipse_Doc_Checklist#Code | code checklist]]</li>
 
     </ul>
 
     </ul>
 +
  </li>
 +
  <li><b>User Documentation</b>
 +
  <ul>
 +
      <li>See [[Eclipse_Doc_Checklist#User_Documentation | User doc checklist]]</li>
 +
  </ul>
 
   </li>
 
   </li>
 
   <li><b>API Compatibility</b>
 
   <li><b>API Compatibility</b>
 
     <ul>
 
     <ul>
       <li>compare all APIs with the previous release.
+
       <li>Make sure that the 'API Tools Version Verification Report' lists no compatibility and no bundle version warning for your bundles</li>
      <br>This can be done manually through CVS or with a tool like [[PDE UI Incubator ApiTools Compare]]
+
       <li>Verify that the 'API Tools Post-API Freeze Report' has no entries</li>
       </li>
+
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
  
   <li><b>3.3 Plug-in Migration Guide</b>
+
   <li><b>Plug-in Migration Guide</b>
 
     <ul>
 
     <ul>
       <li>Instructions for migrating older plug-ins to 3.3</li>
+
       <li>Instructions for migrating older plug-ins to current release</li>
 
       <li>Must describe incompatibilities and breaking API changes</li>
 
       <li>Must describe incompatibilities and breaking API changes</li>
       <li>Should describe deprecations and places where 3.3 has a better story
+
       <li>Should describe deprecations and places where current release has  
        that plug-ins should more to</li>
+
      a better story that plug-ins should more to</li>
 
       <li>Located in Platform Plug-in Developer Guide / Porting Guide</li>
 
       <li>Located in Platform Plug-in Developer Guide / Porting Guide</li>
 +
      <li>Remove old migration guide if necessary (we generally keep three years of migration guides available in each release)
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
   <li><b>What's New in 3.3</b>
+
   <li><b>What's New</b> [JohnA]
 
     <ul>
 
     <ul>
       <li>Describes the more interesting differences that 3.2 users will see
+
       <li>Describes the more interesting differences that users will see
         when they upgrade to 3.3</li>
+
         when they upgrade to the latest release</li>
       <li>Located in {Workbench | Java Development | PDE} User Guide / What's
+
       <li>Located in {Workbench | Java Development | PDE} User Guide / What's new</li>
        new</li>
+
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
   <li><b>Release notes</b>
+
   <li><b>Make sure all bugs with patches have the iplog+ flag set</b>
 
     <ul>
 
     <ul>
       <li>Add known problems for each component and other late-breaking news for
+
       <li>For instructions see [[Eclipse/Bug_Tracking#Tracking_IP_Contributions]]</li>
        customers of 3.3</li>
+
      <li>Located in eclipse/readme/readme_eclipse.html</li>
+
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
<li><b>Source builds</b>
+
  <li><b>Submit the IP Log to Eclipse Legal</b> [JohnA]</li>
 +
  <li><b>Eclipse Project Release Notes</b>
 
     <ul>
 
     <ul>
       <li>Verify that source builds compile and work on all reference platforms.</li>
+
       <li>Add known problems for each component and other late-breaking news for
 +
        customers of this release</li>
 +
      <li>See [https://bugs.eclipse.org/378717 bug 378717] for details</li>
 +
      <li>Update other sections of readme based on current release plan [JohnA]</li>
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
<li><b>Verify that source is included in all SDK features</b>
+
  <li><b>Source builds</b>
 
     <ul>
 
     <ul>
       <li>There were issues with this because of bug [https://bugs.eclipse.org/bugs/show_bug.cgi?id=179616 bug 179616]</li>
+
       <li>Verify that source builds compile and work on all reference platforms.</li>
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
 +
  <li><b>Verify that source is included in all SDK features</b>
 
   </li>
 
   </li>
<li><b>Test updating from update site to platform runtime to other eclipse SDK and runtime features on reference platforms and assorted VMS</b>
+
  <li><b>Test updating from update site to platform runtime to other eclipse SDK and runtime features on reference platforms and assorted VMs</b>
 
   </li>
 
   </li>
<li><b>Test the version of pde build in basebuilder to ensure there aren't any errors</b></li>
+
  <li><b>Test the version of PDE build in basebuilder to ensure there aren't any errors</b></li>
<li><b>Verify that all the "abouts" in the platform, rcp, sdk and cvs features should the correct release name in the about</b></li>
+
  <li><b>Verify that all the "abouts" in the Platform, RCP, SDK and CVS features sow the correct release name in the about</b></li>
 
+
  <li><b>Produce the release review documentation</b> [JohnA]</li>
 
+
 
+
 
+
 
</ol>
 
</ol>

Revision as of 09:21, 4 June 2012

This checklist is used by the Eclipse top-level project in preparing its releases.

  1. Copyright notices
    • All source files must have appropriate EPL v1.0 copyright notice
    • Source files whose content was created in this release should read "Copyright (c)  2011 ..." or "Copyright (c)  2012 ..."
    • Source files whose content was modified during this release should read "Copyright (c)  200x, 2011 ..." or "Copyright (c)  200x, 2012 ..."
    • All features should have "(c) Copyright Eclipse contributors and others 2000, 2012." in Help > About Eclipse SDK
    • Splash screen copyright needs to be updated
  2. Plug-in and feature identification [Dani]
    • Check the info in Help > About Eclipse SDK
    • All features should have provider "Eclipse.org" and a version that adheres to the Versioning guidelines
    • All plug-ins should have provider "Eclipse.org" and version Versioning guidelines, except for known special cases (org.apache.*, org.junit, and bundles from Orbit).
  3. License agreements for features and plug-ins [Dani]
    • Help > About Eclipse SDK > {Feature | Plug-in} Details > More Info
    • All features should link to the Eclipse Foundation Software User Agreement dated February 1, 2011
    • All plug-ins should link to the plug-in's about.html file containing its plug-in-specific license
  4. Extension point documentation
    • Extension points must be documented in the appropriate help book
      • Platform Plug-in Developer Guide; section Reference / Extension Points Reference
      • JDT Plug-in Developer Guide; section Reference / Extension Points Reference
      • PDE Guide; section Reference / Extension Points Reference
    • Must be a link to each extension point that a component has
    • Extension points added in this release must be clearly marked "Since x.y" where x.y is the project release number
    • See also ISV doc checklist
  5. API documentation
    • Java API must be documented in the appropriate help book
      • Platform Plug-in Developer Guide; section Reference / API Reference
      • JDT Plug-in Developer Guide; section Reference / API Reference
      • PDE Guide; section Reference / API Reference
    • Must be a link to each API package that a component has
    • API package must have package overview (package.html)
    • All API elements must be documented
    • API elements added in this release must be tagged "@since x.y" where x.y is the bundle version number
    • See also ISV doc checklist and code checklist
  6. User Documentation
  7. API Compatibility
    • Make sure that the 'API Tools Version Verification Report' lists no compatibility and no bundle version warning for your bundles
    • Verify that the 'API Tools Post-API Freeze Report' has no entries
  8. Plug-in Migration Guide
    • Instructions for migrating older plug-ins to current release
    • Must describe incompatibilities and breaking API changes
    • Should describe deprecations and places where current release has a better story that plug-ins should more to
    • Located in Platform Plug-in Developer Guide / Porting Guide
    • Remove old migration guide if necessary (we generally keep three years of migration guides available in each release)
  9. What's New [JohnA]
    • Describes the more interesting differences that users will see when they upgrade to the latest release
    • Located in {Workbench | Java Development | PDE} User Guide / What's new
  10. Make sure all bugs with patches have the iplog+ flag set
  11. Submit the IP Log to Eclipse Legal [JohnA]
  12. Eclipse Project Release Notes
    • Add known problems for each component and other late-breaking news for customers of this release
    • See bug 378717 for details
    • Update other sections of readme based on current release plan [JohnA]
  13. Source builds
    • Verify that source builds compile and work on all reference platforms.
  14. Verify that source is included in all SDK features
  15. Test updating from update site to platform runtime to other eclipse SDK and runtime features on reference platforms and assorted VMs
  16. Test the version of PDE build in basebuilder to ensure there aren't any errors
  17. Verify that all the "abouts" in the Platform, RCP, SDK and CVS features sow the correct release name in the about
  18. Produce the release review documentation [JohnA]

Back to the top