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 "Eclipse/Release checklist"
< Eclipse
m |
|||
(7 intermediate revisions by the same user not shown) | |||
Line 58: | Line 58: | ||
<li>API elements added in this release must be tagged "@since x.y" where x.y is the bundle version number</li> | <li>API elements added in this release must be tagged "@since x.y" 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>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> | ||
<li><b>User Documentation</b> | <li><b>User Documentation</b> | ||
<ul> | <ul> | ||
− | <li>Update the Tips & Tricks document</li> | + | <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> | <li>See [[Eclipse_Doc_Checklist#User_Documentation | User doc checklist]] for more items</li> | ||
</ul> | </ul> | ||
Line 81: | Line 90: | ||
<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>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= | + | <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. | <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> | ||
Line 90: | Line 99: | ||
when they upgrade to the latest release</li> | when they upgrade to the latest release</li> | ||
<li>Located in {Workbench | Java Development | PDE} User Guide / What's new</li> | <li>Located in {Workbench | Java Development | PDE} User Guide / What's 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> | ||
Line 101: | Line 112: | ||
<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 this release</li> | + | customers of this release.</li> |
− | <li>See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=538337 bug 538337] for details</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>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>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>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>Acknowledgments</b> | <li><b>Acknowledgments</b> | ||
<ul> | <ul> | ||
− | <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.</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> |
Latest revision as of 04:37, 3 December 2018
This checklist is used by the Eclipse top-level project in preparing its releases.
- 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
- 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).
- 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
- 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
- Extension points must be documented in the appropriate help book
- 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
- Java API must be documented in the appropriate help book
- 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
- Update the Tips & Tricks document
- 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
- 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.
- 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.
- Make sure all bugs with patches have the iplog+ flag set
- For instructions see Eclipse/Bug_Tracking#Tracking_IP_Contributions
- Submit the IP Log to Eclipse Legal
- 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.
- 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
- Source builds
- Verify that source builds compile and work on all reference platforms.
- Verify that source is included in all SDK features
- Test updating from update site to platform runtime to other eclipse SDK and runtime features on reference platforms and assorted VMs
- Test the version of PDE build in basebuilder to ensure there aren't any errors
- Produce the release review documentation