Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "TM/3.2 Release Checklist"
< TM
| (11 intermediate revisions by one other user not shown) | |||
| Line 60: | Line 60: | ||
<li>API elements added in this release must be tagged "@since x.y" where x.y is the bundle version number</li> | <li>API elements added in this release must be tagged "@since x.y" 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>Fulltext Search of API must create / use the help index without errors, and must produce hits in the documentation</li> | ||
| − | <li>Update Copyright Year and Release Version 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 also [[Eclipse_Doc_Checklist#ISV_Documentation | ISV doc checklist]] and [[Eclipse_Doc_Checklist#Code | code checklist]]</li> | <li>See also [[Eclipse_Doc_Checklist#ISV_Documentation | ISV doc checklist]] and [[Eclipse_Doc_Checklist#Code | code checklist]]</li> | ||
</ul> | </ul> | ||
| Line 68: | Line 69: | ||
<li>Docs contain no outdated information</li> | <li>Docs contain no outdated information</li> | ||
<li>Update Screenshots where necessary</li> | <li>Update Screenshots where necessary</li> | ||
| − | <li>Update Copyright Year and Release Version where necessary</li> | + | <li>[[Image:Ok green.gif]] Update Copyright Year and Release Version where necessary</li> |
| − | <li>Must not have any broken hyperlinks</li> | + | <li>[[Image:Ok green.gif]] Must not have any broken hyperlinks</li> |
<li>See [[Eclipse_Doc_Checklist#User_Documentation | User doc checklist]]</li> | <li>See [[Eclipse_Doc_Checklist#User_Documentation | User doc checklist]]</li> | ||
</ul> | </ul> | ||
| Line 94: | Line 95: | ||
</ul> | </ul> | ||
</li> | </li> | ||
| − | <li><b>Make sure all bugs with patches have the iplog+ flag set</b> | + | <li>[[Image:Ok green.gif]] <b>Make sure all bugs with patches have the iplog+ flag set</b> [Martin] |
<ul> | <ul> | ||
<li>For instructions see [http://dev.eclipse.org/mhonarc/lists/eclipse-dev/msg08253.html Clarification on use of iplog flag ]</li> | <li>For instructions see [http://dev.eclipse.org/mhonarc/lists/eclipse-dev/msg08253.html Clarification on use of iplog flag ]</li> | ||
</ul> | </ul> | ||
</li> | </li> | ||
| − | <li><b>Submit the IP Log to Eclipse Legal</b> [Martin]</li> | + | <li>[[Image:Ok green.gif]] <b>Submit the IP Log to Eclipse Legal</b> [Martin]</li> |
<li><b>Eclipse Project Release Notes</b> | <li><b>Eclipse Project Release Notes</b> | ||
<ul> | <ul> | ||
| Line 110: | Line 111: | ||
<li><b>Verify that source is included in all SDK features</b> | <li><b>Verify that source is included in all SDK features</b> | ||
<ul> | <ul> | ||
| − | <li>Importing plugin with source from CVS works (randomly test a couple of plugins)</li> | + | <li>[[Image:Ok green.gif]] Importing plugin with source from CVS works (randomly test a couple of plugins)</li> |
| − | <li>Importing plugin with source from Target Platform does not produce compile errors (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>Running Unittests from rse.tests plugin imported as source from the target platform works</li> | + | <li>[[Image:Ok green.gif]] Running Unittests from rse.tests plugin imported as source from the target platform works</li> |
</ul> | </ul> | ||
</li> | </li> | ||
| − | <li><b>Unittests</b> | + | <li>[[Image:Ok green.gif]] <b>Unittests</b> |
<ul> | <ul> | ||
| − | <li> | + | <li>All known Unittest Failures must have an associated bugzilla entry</li> |
</ul> | </ul> | ||
<li><b>Test installing from update site on reference platforms</b> | <li><b>Test installing from update site on reference platforms</b> | ||
<ul> | <ul> | ||
| − | <li>Test updating 3.1 to 3.2 on reference | + | <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> | </ul> | ||
</li> | </li> | ||
| − | <li><b>Clean-up Bugzilla Target Milestones</b> | + | <li>[[Image:Ok green.gif]] Enable <b>[[Equinox p2 download stats]]</b><ul> |
| − | <li><b>Produce the release review documentation</b> [Martin]</li> | + | <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 > 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> | </ol> | ||
Latest revision as of 06:23, 25 February 2011
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.
Copyright notices [Martin]
- 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 ..."
- 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).
- Plug-in and feature identification [Martin]
- Check the info in Help > About Eclipse SDK
- All features should have provider "Eclipse.org - DSDP" and a version that adheres to the
Version Numbering guidelines.
- All plug-ins should have provider "Eclipse.org - DSDP" and version as per the
Version Numbering guidelines, except for known special cases (org.apache.*,
org.junit, and bundles from Orbit).
- License agreements for features and plug-ins [Martin]
- 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
- RSE Developer Guide / 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
- RSE Developer Guide / Reference / Remote Systems API Reference All Packages as well as Reference by Topic
- RSE DStore Developer Guide / Reference / DStore 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
- Fulltext Search of API must create / use the help index without errors, and must produce hits in the documentation
- Update Copyright Year and Release Version where necessary
- Must not have any broken hyperlinks
- See also ISV doc checklist and code checklist
- Java API must be documented in the appropriate help book
- User Documentation
- Docs contain no outdated information
- Update Screenshots where necessary
- Update Copyright Year and Release Version where necessary
- Must not have any broken hyperlinks
- See User doc checklist
- API Compatibility [Martin]
- 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
- What's New
- Describes the more interesting differences that users will see when they upgrade to the latest release
- Make sure all bugs with patches have the iplog+ flag set [Martin]
- For instructions see Clarification on use of iplog flag
- Submit the IP Log to Eclipse Legal [Martin]
- 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
- Update other sections of readme based on current release plan
- Verify that source is included in all SDK features
- Importing plugin with source from CVS works (randomly test a couple of plugins)
- Importing plugin with source from Target Platform does not produce compile errors (randomly test a couple of plugins)
- Running Unittests from rse.tests plugin imported as source from the target platform works
- Unittests
- All known Unittest Failures must have an associated bugzilla entry
- Test installing from update site on reference platforms
- Test updating 3.1 to 3.2 on one reference platform
- Test installing / running on minimal target (Platform runtime only without JDT or CDT; J2SE-1.4 only)
- Enable Equinox p2 download stats
- Review / Update DL Stat version identification
- Local TM Repo: /stats/dsdp/tm/org.eclipse.rse.*_tm320
- Helios Repo: /stats/releases/helios/org.eclipse.rse.*_tm320
- ZIP Downloads: /dsdp/tm/downloads/drops/R-3.2-
- Release Train Contribution
- Ensure train contribution comes from a "staging" site with download stats enabled
- Test installing / updating from train staging site
- Verify download stats being generated
- Clean-up Bugzilla Target Milestones
- Produce the release review documentation [Martin]
- Run PDE Tools > Organize Manifests... to ensure all packages are exported with x-internal according to API status
- Ensure that Project Set Files (.PSF) contain all projects / plugins / features needed for adopters
- Prepare for the Helios/Final Daze
- At Release Time: Tag the CVS and SVN Repositories with the R3_2 release identifier
- TM: R3_2, TCF: tags/0.3.0
