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 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> | ||
Line 4: | 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 for 3.3 should read "Copyright | <li>Source files whose content was created for 3.3 should read "Copyright | ||
− | (c) | + | (c) 2009 ..."</li> |
− | <li>Source files whose content was modified during 3. | + | <li>Source files whose content was modified during 3.5.x cycle should read |
− | "Copyright (c) 200x, | + | "Copyright (c) 200x, 2009 ..."</li> |
<li>All features should have "(c) Copyright Eclipse contributors and | <li>All features should have "(c) Copyright Eclipse contributors and | ||
− | others 2000, | + | others 2000, 2009." in Help > About Eclipse Platform</li> |
− | <li> | + | <li>Splash screen copyright needs to be updated</li> |
− | + | ||
</ul> | </ul> | ||
</li> | </li> | ||
Line 23: | Line 24: | ||
[[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 | + | <li>Compare release build with last release using the version compare tool.</li> |
</ul> | </ul> | ||
</li> | </li> | ||
Line 48: | Line 49: | ||
</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 | + | <li>Extension points added in this release must be clearly marked "Since |
− | + | x.y" where x.y is the project release number</li> | |
</ul> | </ul> | ||
</li> | </li> | ||
Line 76: | Line 77: | ||
</li> | </li> | ||
− | <li><b> | + | <li><b>Plug-in Migration Guide</b> |
<ul> | <ul> | ||
− | <li>Instructions for migrating older plug-ins to | + | <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 | + | <li>Should describe deprecations and places where current release has |
− | + | 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 | + | <li><b>What's New</b> |
<ul> | <ul> | ||
− | <li>Describes the more interesting differences that | + | <li>Describes the more interesting differences that users will see |
− | when they upgrade to | + | 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> | ||
Line 96: | Line 98: | ||
<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 | + | customers of this release</li> |
<li>Located in eclipse/readme/readme_eclipse.html</li> | <li>Located in eclipse/readme/readme_eclipse.html</li> | ||
</ul> | </ul> |
Revision as of 14:25, 5 August 2009
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 for 3.3 should read "Copyright (c) 2009 ..."
- Source files whose content was modified during 3.5.x cycle should read "Copyright (c) 200x, 2009 ..."
- All features should have "(c) Copyright Eclipse contributors and others 2000, 2009." 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 Mar. 17, 2005
- 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
- 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 3.3 must be tagged "@since 3.3"
- Java API must be documented in the appropriate help book
- API Compatibility
- compare all APIs with the previous release.
This can be done manually through CVS or with a tool like PDE UI Incubator ApiTools Compare
- compare all APIs with the previous release.
- 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
- Release notes
- Add known problems for each component and other late-breaking news for customers of this release
- Located in eclipse/readme/readme_eclipse.html
- Source builds
- Verify that source builds compile and work on all reference platforms.
- Verify that source is included in all SDK features
- There were issues with this because of bug bug 179616
- 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