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
 
(43 intermediate revisions by 10 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>Source files whose content was created for 3.3 should read &quot;Copyright
 
−
        (c)&nbsp; 2007 ...&quot;</li>
 
−
      <li>Source files whose content was modified during 3.3 cycle should read
 
−
        &quot;Copyright (c)&nbsp; 200x, 2007 ...&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, 2018. All rights reserved.&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>
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
 
   <li><b>Plug-in and feature identification</b>
 
   <li><b>Plug-in and feature identification</b>
 
     <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 20: Line 17:
 
         </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>
Line 29: Line 25:
 
       <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 39: Line 33:
 
       <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 55: Line 48:
 
       <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 64: Line 56:
 
       <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>
 +
      <li>Run SWT Javadoc bash tool to have consistent API javadoc across platforms</li>
 
     </ul>
 
     </ul>
 +
  </li>
 +
  <li><b>User Documentation</b>
 +
  <ul>
 +
      <li>Update the Tips & Tricks document
 +
      <ul>
 +
        <li>Go through the N&N documents for Platform, JDT and PDE and identify tips for each of the components</li>
 +
        <li>Add the tips to the appropriate sections for each of the components</li>
 +
        <li>Remove the new.png image from the entries from the previous release (search for image tags with "images/new.png")</li>
 +
        <li>Add the new.png image to the new entries for the current release (add image tag with "images/new.png")</li>
 +
        <li>See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=538624 bug 538624] for details of the files to be updated.</li>
 +
      </ul>
 +
      </li>
 +
      <li>See [[Eclipse_Doc_Checklist#User_Documentation | User doc checklist]] for more items</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)
 +
      <li>The Migration documents need to be created for both Platform and Jdt.See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=537923 bug 537923] for details.
 +
      <li>The Table Of Content entries also need to be created for these documents. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=538766 bug 538766] for details.
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
−
   <li><b>What's New in 3.3</b>
+
   <li><b>What's New</b>
 
     <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>
+
      <li>These items also go to the New & Noteworthy page of the corresponding release.</li>
 +
      <li>Add newly added quick assists and quick fixes to documentation. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=534908 bug 534908].</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>
 +
      <li>For instructions see [[Eclipse/Bug_Tracking#Tracking_IP_Contributions]]</li>
 +
    </ul>
 +
  </li>
 +
  <li><b>Submit the IP Log to Eclipse Legal</b></li>
 +
  <li><b>Eclipse Project Release Notes</b>
 
     <ul>
 
     <ul>
 
       <li>Add known problems for each component and other late-breaking news for
 
       <li>Add known problems for each component and other late-breaking news for
−
         customers of 3.3</li>
+
         customers of this release.</li>
−
       <li>Located in eclipse/readme/readme_eclipse.html</li>
+
       <li>See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=538337 bug 538337] for details.</li>
 +
      <li>Clone https://git.eclipse.org/c/www.eclipse.org/eclipse.git./</li>
 +
      <li>Add a new file for read me for the Eclipse release version (ex readme_eclipse_4.9.html and readme_eclipse_4.9.php) under the development Project.</li>
 +
      <li>Update sections of readme based on current release plan.</li>
 +
      <li> The new read me file (ex readme_eclipse_4.9.html) should be copied to eclipse.platform.releng/features/org.eclipse.rcp/rootfiles/readme/readme_eclipse.html.</li>
 
     </ul>
 
     </ul>
 
   </li>
 
   </li>
−
<li><b>Source builds</b>
+
  <li><b>Acknowledgments</b>
 
     <ul>
 
     <ul>
−
       <li>Verify that source builds compile and work on all reference platforms.</li>
+
       <li>Each component can thank its contributors on the acknowledgments page. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=538336 bug 538336] for details. To get the list of contributors the following script can be used</li>
 +
<nowiki>
 +
!/bin/bash
 +
# Allows to extract a list of contributors for the Eclipse platform repos
 +
# Run from directory which contains all the repos listed below
 +
 
 +
function addContributorsFromRepo {
 +
    cd $1
 +
    echo "Working on $1"
 +
    git checkout master
 +
    git pull
 +
    git log R4_9..master --pretty=format:"%an" | sort -u  >>  ../contributors.txt
 +
    cd ..
 +
}
 +
 
 +
addContributorsFromRepo eclipse.platform.ui
 +
addContributorsFromRepo eclipse.platform.ua
 +
addContributorsFromRepo eclipse.platform.ui.tools
 +
addContributorsFromRepo eclipse.platform.text
 +
addContributorsFromRepo eclipse.platform.releng
 +
addContributorsFromRepo eclipse.platform.team
 +
addContributorsFromRepo eclipse.platform.swt
 +
addContributorsFromRepo eclipse.platform.swt.binaries
 +
addContributorsFromRepo eclipse.platform.debug
 +
addContributorsFromRepo eclipse.platform
 +
addContributorsFromRepo eclipse.platform.resources
 +
addContributorsFromRepo eclipse.platform.runtime
 +
addContributorsFromRepo .
 +
#addContributorsFromRepo eclipse.jdt
 +
#addContributorsFromRepo eclipse.jdt.core
 +
#addContributorsFromRepo eclipse.jdt.core.binaries
 +
#addContributorsFromRepo eclipse.jdt.debug
 +
#addContributorsFromRepo eclipse.jdt.ui
 +
#addContributorsFromRepo eclipse.pde.ui
 +
#addContributorsFromRepo eclipse.pde.build
 +
#addContributorsFromRepo rt.equinox.binaries
 +
#addContributorsFromRepo rt.equinox.bundles
 +
#addContributorsFromRepo rt.equinox.framework
 +
#addContributorsFromRepo rt.equinox.p2
 +
 
 +
sort -u  contributors.txt -o contributors1.txt
 +
</nowiki>
 
     </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>Produce the release review documentation</b></li>
−
 
+
−
 
+
−
 
+
−
 
+
 
</ol>
 
</ol>

Latest revision as of 04:37, 3 December 2018

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

  1. Copyright notices
    • All features should have "(c) Copyright Eclipse contributors and others 2000, 2018. All rights reserved." in Help > About Eclipse SDK
    • Splash screen copyright needs to be updated
  2. Plug-in and feature identification
    • 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
    • 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
    • Run SWT Javadoc bash tool to have consistent API javadoc across platforms
  6. User Documentation
    • Update the Tips & Tricks document
      • Go through the N&N documents for Platform, JDT and PDE and identify tips for each of the components
      • Add the tips to the appropriate sections for each of the components
      • Remove the new.png image from the entries from the previous release (search for image tags with "images/new.png")
      • Add the new.png image to the new entries for the current release (add image tag with "images/new.png")
      • See bug 538624 for details of the files to be updated.
    • See User doc checklist for more items
  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)
    • The Migration documents need to be created for both Platform and Jdt.See bug 537923 for details.
    • The Table Of Content entries also need to be created for these documents. See bug 538766 for details.
  9. What's New
    • 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
    • These items also go to the New & Noteworthy page of the corresponding release.
    • Add newly added quick assists and quick fixes to documentation. See bug 534908.
  10. Make sure all bugs with patches have the iplog+ flag set
  11. Submit the IP Log to Eclipse Legal
  12. Eclipse Project Release Notes
    • Add known problems for each component and other late-breaking news for customers of this release.
    • See bug 538337 for details.
    • Clone https://git.eclipse.org/c/www.eclipse.org/eclipse.git./
    • Add a new file for read me for the Eclipse release version (ex readme_eclipse_4.9.html and readme_eclipse_4.9.php) under the development Project.
    • Update sections of readme based on current release plan.
    • The new read me file (ex readme_eclipse_4.9.html) should be copied to eclipse.platform.releng/features/org.eclipse.rcp/rootfiles/readme/readme_eclipse.html.
  13. Acknowledgments
    • Each component can thank its contributors on the acknowledgments page. See bug 538336 for details. To get the list of contributors the following script can be used
      • !/bin/bash
# Allows to extract a list of contributors for the Eclipse platform repos
# Run from directory which contains all the repos listed below

function addContributorsFromRepo {
    cd $1
    echo "Working on $1"
    git checkout master
    git pull
    git log R4_9..master --pretty=format:"%an" | sort -u  >>  ../contributors.txt
    cd ..
}

addContributorsFromRepo eclipse.platform.ui
addContributorsFromRepo eclipse.platform.ua
addContributorsFromRepo eclipse.platform.ui.tools
addContributorsFromRepo eclipse.platform.text
addContributorsFromRepo eclipse.platform.releng
addContributorsFromRepo eclipse.platform.team
addContributorsFromRepo eclipse.platform.swt
addContributorsFromRepo eclipse.platform.swt.binaries
addContributorsFromRepo eclipse.platform.debug
addContributorsFromRepo eclipse.platform
addContributorsFromRepo eclipse.platform.resources
addContributorsFromRepo eclipse.platform.runtime
addContributorsFromRepo .
#addContributorsFromRepo eclipse.jdt
#addContributorsFromRepo eclipse.jdt.core
#addContributorsFromRepo eclipse.jdt.core.binaries
#addContributorsFromRepo eclipse.jdt.debug
#addContributorsFromRepo eclipse.jdt.ui
#addContributorsFromRepo eclipse.pde.ui
#addContributorsFromRepo eclipse.pde.build
#addContributorsFromRepo rt.equinox.binaries
#addContributorsFromRepo rt.equinox.bundles
#addContributorsFromRepo rt.equinox.framework
#addContributorsFromRepo rt.equinox.p2

sort -u  contributors.txt -o contributors1.txt
  14. Source builds
    • Verify that source builds compile and work on all reference platforms.
  15. Verify that source is included in all SDK features
  16. Test updating from update site to platform runtime to other eclipse SDK and runtime features on reference platforms and assorted VMs
  17. Test the version of PDE build in basebuilder to ensure there aren't any errors
  18. Produce the release review documentation
Retrieved from "https://wiki.eclipse.org/index.php?title=Eclipse/Release_checklist&oldid=429525"

This page was last modified 04:37, 3 December 2018 by Sravan Kumar Lakkimsetti. Based on work by Noopur Gupta, Sarika Sinha and Jayaprakash Arthanareeswaran and others.

Copyright © Eclipse Foundation, Inc. All Rights Reserved.