"Daniel John Debrunner (JIRA)" <[EMAIL PROTECTED]> writes: > Dag, could you explain why a release note is needed. I thought > release notes were for changes that might affect existing working > applications, I didn't think new features had release notes?
Thanks for addressing this, Dan. I admit I am slightly unclear on this, so I did some digging. For bracketed comments, I agree it is more reasonable to list the JIRA in the "features" section of the relase notes, also since bracketed comments have a SQL feature number; Optional Feature T352. The JIRA is marked as a New Feature in JIRA so finding it for the release manager when preparing the relase notes is not an issue. We have the Wiki for "big" features listed here: http://wiki.apache.org/db-derby/DerbyTenFourRelease?highlight=%28tenfour%29 In the 10.3 release notes I see: "Compared with the previous release (10.2.2.0), Derby release 10.3.1.4 introduces the following new features and incompatibilities. These merit your special attention." and then proceeds to list the release notes generated from JIRAs. Maybe it should read "new features and improvements which may have impact on existing applications and bugs"? In http://wiki.apache.org/db-derby/ReleaseNoteProcess, we describe the release note process, but that page doesn't give any advise as to when a release note is needed. It uses the phrase "releaseNotes.html files which were attached to significant JIRAs". Btw, we also have a JIRA flag for "affects existing applications" - is the "release note needed" flag redundant, then? Should all JIRAs whose inclusion "affects existing applications" also have a releaseNote.html, or only the "significant" ones? http://wiki.apache.org/db-derby/DerbySnapshotOrRelease?highlight=%28existing%29%7C%28application%29 says that releaseNotes.html is expected to be found "marked with 'Existing Application Impact' or 'Release Note Needed'" (if fixed and new is this release). I could not find any description of/guidance on these flags in http://db.apache.org/derby/binaries/FilingDerbyIssuesInJira.doc Finally, the relase notes also provides a convenient place to give a short introduction to new features (pointers to doc if nothing else). Could not that justify the inclusion even if there is no impact on existing apps? Dag
