View source for TM/3.2 Release Checklist

This checklist is used to ensure that no important cleanup work is forgotten preparing releases. Its content is aligned with the [[Eclipse/Release checklist]] in use by the Platform.

<ol>
  <li>[[Image:Ok green.gif]] <b>Copyright notices</b> [Martin]
    <ul>
      <li>[[Image:Ok green.gif]] All source files must have appropriate EPL v1.0 copyright notice</li>
      <li>[[Image:Ok green.gif]] Source files whose content was created in this release should read
       &quot;Copyright (c)&nbsp; 2009 ...&quot; or &quot;Copyright (c)&nbsp; 2010 ...&quot;</li>
      <li>[[Image:Ok green.gif]] Source files whose content was modified during this release should read 
        &quot;Copyright (c)&nbsp; 200x, 2009 ...&quot; or &quot;Copyright (c)&nbsp; 200x, 2010 ...&quot;</li>
      <li>[[Image:Ok green.gif]] The about dialog content for each feature (which is provided by its associated branding plugin)
has a proper release version identification, Copyright Owner, Copyright year and 3rd party license notices as required
(e.g. by included Apache plugins).
        </li>
    </ul>
  </li>
  <li>[[Image:Ok green.gif]] <b>Plug-in and feature identification</b> [Martin]
    <ul>
      <li>Check the info in Help &gt; About Eclipse SDK</li>
      <li>[[Image:Ok green.gif]] All features should have provider &quot;Eclipse.org - DSDP&quot; and a version that adheres to the
[[Version Numbering]] guidelines.
        </li>
      <li>[[Image:Ok green.gif]] All plug-ins should have provider &quot;Eclipse.org - DSDP&quot; and version as per the
[[Version Numbering]] guidelines, except for known special cases (org.apache.*,
        org.junit, and bundles from Orbit).</li>
    </ul>
  </li>
  <li><b>License agreements for features and plug-ins</b> [Martin]
    <ul>
      <li>Help &gt; About Eclipse SDK &gt; {Feature | Plug-in} Details &gt;
        More Info</li>
      <li>[[Image:Ok green.gif]] 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>
    </ul>
  </li>
  <li><b>Extension point documentation</b>
    <ul>
      <li>Extension points must be documented in the appropriate help book
        <ul>
          <li>RSE Developer Guide / Reference / [http://dsdp.eclipse.org/help/latest/topic/org.eclipse.rse.doc.isv/reference/extension-points/index.html Extension Points Reference]</li>
        </ul>
      </li>
      <li>Must be a link to each extension point that a component has</li>
      <li>Extension points added in this release must be clearly marked &quot;Since
        x.y&quot; where x.y is the project release number</li>
      <li>See also [[Eclipse_Doc_Checklist#ISV_Documentation | ISV doc checklist]]</li>
    </ul>
  </li>
  <li><b>API documentation</b>
    <ul>
      <li>Java API must be documented in the appropriate help book
        <ul>
          <li>RSE Developer Guide / Reference / [http://dsdp.eclipse.org/help/latest/topic/org.eclipse.rse.doc.isv/reference/api/overview-summary.html Remote Systems API Reference All Packages] as well as Reference by Topic</li>
          <li>RSE DStore Developer Guide / Reference / [http://dsdp.eclipse.org/help/latest/topic/org.eclipse.dstore.doc.isv/reference/api/overview-summary.html DStore API Reference]</li>
        </ul>
      </li>
      <li>Must be a link to each API package that a component has</li>
      <li>API package must have package overview (package.html)</li>
      <li>All API elements must be documented</li>
      <li>API elements added in this release must be tagged &quot;@since x.y&quot; where x.y is the bundle version number</li>
      <li>Fulltext Search of API must create / use the help index without errors, and must produce hits in the documentation</li>
      <li>[[Image:Ok green.gif]] Update Copyright Year and Release Version where necessary</li>
      <li>[[Image:Ok green.gif]] Must not have any broken hyperlinks</li>
      <li>See also [[Eclipse_Doc_Checklist#ISV_Documentation | ISV doc checklist]] and [[Eclipse_Doc_Checklist#Code | code checklist]]</li>
    </ul>
  </li>
  <li><b>User Documentation</b>
  <ul>
      <li>Docs contain no outdated information</li>
      <li>Update Screenshots where necessary</li>
      <li>[[Image:Ok green.gif]] Update Copyright Year and Release Version where necessary</li>
      <li>[[Image:Ok green.gif]] Must not have any broken hyperlinks</li>
      <li>See [[Eclipse_Doc_Checklist#User_Documentation | User doc checklist]]</li>
  </ul>
  </li>
  <li>[[Image:Ok green.gif]] <b>API Compatibility</b> [Martin]
    <ul>
      <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>
    </ul>
  </li>

  <li><b>Plug-in Migration Guide</b>
    <ul>
      <li>Instructions for migrating older plug-ins to current release</li>
      <li>Must describe incompatibilities and breaking API changes</li>
      <li>Should describe deprecations and places where current release has 
      a better story that plug-ins should more to</li>
    </ul>
  </li>
  <li><b>What's New</b>
    <ul>
      <li>Describes the more interesting differences that users will see
        when they upgrade to the latest release</li>
    </ul>
  </li>
  <li>[[Image:Ok green.gif]] <b>Make sure all bugs with patches have the iplog+ flag set</b> [Martin]
    <ul>
      <li>For instructions see [http://dev.eclipse.org/mhonarc/lists/eclipse-dev/msg08253.html Clarification on use of iplog flag ]</li>
    </ul>
  </li>
  <li>[[Image:Ok green.gif]] <b>Submit the IP Log to Eclipse Legal</b> [Martin]</li>
  <li><b>Eclipse Project Release Notes</b>
    <ul>
      <li>Add known problems for each component and other late-breaking news for
        customers of this release</li>
      <li>See [https://bugs.eclipse.org/313131 bug 313131] for details</li>
      <li>Update other sections of readme based on current release plan</li>
    </ul>
  </li>
  <li><b>Verify that source is included in all SDK features</b>
    <ul>
      <li>[[Image:Ok green.gif]] Importing plugin with source from CVS works (randomly test a couple of plugins)</li>
      <li>[[Image:Ok green.gif]] Importing plugin with source from Target Platform does not produce compile errors (randomly test a couple of plugins)</li>
      <li>[[Image:Ok green.gif]] Running Unittests from rse.tests plugin imported as source from the target platform works</li>
    </ul>
  </li>
  <li>[[Image:Ok green.gif]] <b>Unittests</b>
    <ul>
      <li>All known Unittest Failures must have an associated bugzilla entry</li>
    </ul>
  <li><b>Test installing from update site on reference platforms</b>
    <ul>
      <li>Test updating 3.1 to 3.2 on one reference platform</li>
      <li>Test installing / running on minimal target (Platform runtime only without JDT or CDT; J2SE-1.4 only)</li>
    </ul>
  </li>
  <li>[[Image:Ok green.gif]] Enable <b>[[Equinox p2 download stats]]</b><ul>
    <li>Review / <b>Update DL Stat version identification</b></li>
    <li>Local TM Repo: /stats/dsdp/tm/org.eclipse.rse.*_tm320</li>
    <li>Helios Repo: /stats/releases/helios/org.eclipse.rse.*_tm320</li>
    <li>ZIP Downloads: /dsdp/tm/downloads/drops/R-3.2-</li>
  </ul></li>
  <li><b>Release Train Contribution</b><ul>
    <li>Ensure train contribution comes from a "staging" site with <b>download stats enabled</b></li>
    <li>Test installing / updating from train staging site</li>
    <li>Verify download stats being generated</li>
  </ul></li>
  <li>[[Image:Ok green.gif]] <b>Clean-up Bugzilla Target Milestones</b>
  <li>[[Image:Ok green.gif]] <b>Produce the release review documentation</b> [Martin]</li>
  <li>[[Image:Ok green.gif]] Run <b>PDE Tools &gt; Organize Manifests...</b> to ensure all packages are exported with x-internal according to API status</li>
  <li>Ensure that <b>Project Set Files (.PSF)</b> contain all projects / plugins / features needed for adopters
  <li>Prepare for the [[Helios/Final Daze]]
  <li>[[Image:Ok green.gif]]At Release Time: Tag the <b>CVS and SVN Repositories</b> with the R3_2 release identifier<ul>
      <li>TM: R3_2, TCF: tags/0.3.0</li>
  </ul></li>
</ol>