Jump to: navigation, search

Eclipse/Release checklist

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

  1. 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 ..."
    • Source files whose content was modified during this release should read "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
  2. 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.
  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 Mar. 17, 2005
    • 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
  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
  6. API Compatibility
  7. 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)
  8. 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
  9. 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
  10. Source builds
    • Verify that source builds compile and work on all reference platforms.
  11. Verify that source is included in all SDK features
    • There were issues with this because of bug bug 179616
  12. Test updating from update site to platform runtime to other eclipse SDK and runtime features on reference platforms and assorted VMS
  13. Test the version of pde build in basebuilder to ensure there aren't any errors
  14. Verify that all the "abouts" in the platform, rcp, sdk and cvs features should the correct release name in the about