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
Line 36: | Line 36: | ||
<li><b>Extension point documentation</b> | <li><b>Extension point documentation</b> | ||
<ul> | <ul> | ||
− | <li>Extension points must be documented in the appropriate help book | + | <li>[[Image:Ok green.gif]] Extension points must be documented in the appropriate help book |
<ul> | <ul> | ||
− | <li>Platform Plug-in Developer Guide; section Reference / Extension | + | <li>[[Image:Ok green.gif]] Platform Plug-in Developer Guide; section Reference / Extension Points Reference</li> |
− | + | <li>[[Image:Ok green.gif]] JDT Plug-in Developer Guide; section Reference / Extension Points Reference</li> | |
− | <li>JDT Plug-in Developer Guide; section Reference / Extension Points | + | <li>[[Image:Ok green.gif]] 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>[[Image:Ok green.gif]] Must be a link to each extension point that a component has</li> |
<li>Extension points added in this release must be clearly marked "Since | <li>Extension points added in this release must be clearly marked "Since | ||
x.y" where x.y is the project release number</li> | x.y" where x.y is the project release number</li> |
Revision as of 09:16, 18 May 2011
This checklist is used by the Eclipse top-level project in preparing its releases.
- 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) 2010 ..." or "Copyright (c) 2011 ..."
- Source files whose content was modified during this release should read "Copyright (c) 200x, 2010 ..." or "Copyright (c) 200x, 2011 ..."
- All features should have "(c) Copyright Eclipse contributors and others 2000, 2011." in Help > About Eclipse SDK
- Splash screen copyright needs to be updated
- 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).
- License agreements for features and plug-ins [Dani]
- Extension point documentation
- Extension points must be documented in the appropriate help book
- 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
- 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
- Java API must be documented in the appropriate help book
- User Documentation
- 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)
- 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
- 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 [JohnA]
- Eclipse Project Release Notes
- Add known problems for each component and other late-breaking news for customers of this release
- See bug 344920 for details
- Update other sections of readme based on current release plan [JohnA]
- 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
- Verify that all the "abouts" in the Platform, RCP, SDK and CVS features sow the correct release name in the about
- Produce the release review documentation [JohnA]