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 |
|||
| Line 6: | Line 6: | ||
<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 in this release should read | <li>Source files whose content was created in this release should read | ||
| − | "Copyright (c) 2010 ..."</li> | + | "Copyright (c) 2009 ..." or "Copyright (c) 2010 ..."</li> |
<li>Source files whose content was modified during this release should read | <li>Source files whose content was modified during this release should read | ||
| − | "Copyright (c) 200x, 2010 ..."</li> | + | "Copyright (c) 200x, 2009 ..." or "Copyright (c) 200x, 2010 ..."</li> |
<li>All features should have "(c) Copyright Eclipse contributors and | <li>All features should have "(c) Copyright Eclipse contributors and | ||
others 2000, 2010." in Help > About Eclipse Platform</li> | others 2000, 2010." in Help > About Eclipse Platform</li> | ||
| Line 31: | Line 31: | ||
<li>Help > About Eclipse SDK > {Feature | Plug-in} Details > | <li>Help > About Eclipse SDK > {Feature | Plug-in} Details > | ||
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 April 14, 2010</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 | + | |
| − | + | ||
</ul> | </ul> | ||
</li> | </li> | ||
| Line 51: | Line 49: | ||
<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> | ||
| + | <li>See also [[Eclipse_Doc_Checklist#ISV_Documentation | ISV doc checklist]]</li> | ||
</ul> | </ul> | ||
</li> | </li> | ||
| Line 57: | Line 56: | ||
<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> |
| − | + | ||
<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 66: | Line 64: | ||
<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 this release must be tagged "@since x.y" | + | <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> | |
</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> | + | <li>Make sure that the 'API Tools Version Verification Report' lists no compatibility and no bundle version warning for your bundles</li> |
| − | + | <li>Verify that the 'API Tools Post-API Freeze Report' has no entries</li> | |
| − | </li> | + | |
</ul> | </ul> | ||
</li> | </li> | ||
| Line 92: | Line 94: | ||
<li>Describes the more interesting differences that users will see | <li>Describes the more interesting differences that users will see | ||
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 | + | <li>Located in {Workbench | Java Development | PDE} User Guide / What's new</li> |
| − | + | ||
</ul> | </ul> | ||
</li> | </li> | ||
| − | <li><b>Release | + | <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 this release</li> | customers of this release</li> | ||
| − | <li> | + | <li>See [https://bugs.eclipse.org/313131 bug 313131] for details</li> |
</ul> | </ul> | ||
</li> | </li> | ||
| Line 109: | Line 110: | ||
</li> | </li> | ||
<li><b>Verify that source is included in all SDK features</b> | <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> | </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>Test the version of | + | |
| − | <li><b>Verify that all the "abouts" in the | + | |
| − | + | ||
| − | + | ||
</ol> | </ol> | ||
Revision as of 09:44, 17 May 2010
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) 2009 ..." or "Copyright (c) 2010 ..."
- Source files whose content was modified during this release should read "Copyright (c) 200x, 2009 ..." or "Copyright (c) 200x, 2010 ..."
- All features should have "(c) Copyright Eclipse contributors and others 2000, 2010." in Help > About Eclipse Platform
- Splash screen copyright needs to be updated
- Plug-in and feature identification
- Check this info from 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).
- Compare release build with last release using the version compare tool.
- 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 April 14, 2010
- 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
- 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
- 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
- Eclipse Project Release Notes
- Add known problems for each component and other late-breaking news for customers of this release
- See bug 313131 for details
- 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 should the correct release name in the about