Mailing-List: contact derby-commits-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Derby Development" <derby-dev@db.apache.org>
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
From: Apache Wiki <wikidiffs@apache.org>
To: Apache Wiki <wikidiffs@apache.org>
Date: Wed, 21 Apr 2010 20:24:44 -0000
Message-ID: <20100421202444.5279.53554@eos.apache.org>
Subject: 
 =?utf-8?q?=5BDb-derby_Wiki=5D_Update_of_=22ReleaseNoteProcess=22_by_Richa?=
 =?utf-8?q?rdHillegas?=

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Db-derby Wiki" for =
change notification.

The "ReleaseNoteProcess" page has been changed by RichardHillegas.
http://wiki.apache.org/db-derby/ReleaseNoteProcess?action=3Ddiff&rev1=3D16&=
rev2=3D17

--------------------------------------------------

  =

  To generate `RELEASE-NOTES.html`, the Release Manager first prepares the =
environment:
  =

-  * '''Build''' - Builds the branch codeline in order to compile the [[htt=
ps://svn.apache.org/repos/asf/db/derby/code/trunk/java/build/org/apache/der=
byBuild/ReleaseNotesGenerator.java|ReleaseNotesGenerator]] program. Before =
doing this, make sure that you edit !JiraIssue.java in order to hardcode th=
e attachment ids for the issues which have detailed release notes. These at=
tachment ids are hardcoded in the method genReleaseNoteAttachmentID(). See =
the comments in that method for more information.
+  * '''Build''' - Builds the branch codeline in order to compile the [[htt=
ps://svn.apache.org/repos/asf/db/derby/code/trunk/java/build/org/apache/der=
byBuild/ReleaseNotesGenerator.java|ReleaseNotesGenerator]] program.
   * '''Summarize''' - Fills in a summary of the release. This involves fil=
ling in the top level `releaseSummary.xml` file, based on the instructions =
in its template file tools/release/templates/releaseSummaryTemplate.xml.
-  * '''Report''' - Generates two xml JIRA reports:
+  * '''Report''' - Generates a JIRA report:
+    * `fixedBugsList.xml` - This is the list of issues addressed by the re=
lease. To generate this file you need to use the appropriate search or filt=
er in Jira. You will typically need to create a new filter for each release=
. The criteria for `fixedBugsList.xml` will be something like fixversion=3D=
<branch or all release candidate versions>, resolution=3Dfixed and type=3Db=
ug. For more information on producing this report, see the header comment o=
n !ReportParser$April_2010. Save this report to disk. In some browsers you =
can then right-click this link and select "Save link as..." from the result=
ing menu. Make sure you change the name to `fixedBugsList.xml` and save it =
in the location pointed to by `relnotes.src.reports` as described below. =

+  * '''Tweak''' - You will need to write your own implementation of !Repor=
tParser. That is because the shape of JIRA reports changes significantly be=
tween Derby releases. Fortunately, it is easy to write one of these parsers=
. See !ReportParser$April_2010 as an example.
-    * `fixedBugsList.xml` - This is the list of issues addressed by the re=
lease
-    * `releaseNotesList.xml` - This is the list of issues bearing detailed=
 releaseNotes.html explanations.
-  To generate these two files you need to use the appropriate search or fi=
lter in Jira. You will typically need to create a new filter for each relea=
se. The criteria for `fixedBugsList.xml` will be something like fixversion=
=3D<branch or all release candidate versions>, resolution=3Dfixed and type=
=3Dbug. For `releaseNotesList.xml` you also need to check the release note =
checkbox.
-  After running the search in Jira the you will see a link called "XML" ab=
ove the search results. In some browsers you can then right-click this link=
 and select "Save link as..." from the resulting menu. Make sure you change=
 the name (to `fixedBugsList.xml` or `releaseNotesList.xml` as appropriate)=
, and save it in the location pointed to by `relnotes.src.reports` as descr=
ibed below. Each of these reports begins with a DOCTYPE declaration. These =
declarations point at a DTD which is not present on your machine; those ref=
erences choke the release notes generator, so remove the DOCTYPE declaratio=
ns and replace them with the following line:
- =

- <!DOCTYPE xsl:stylesheet [<!ENTITY nbsp "&amp;#160;">]>
  =

  Then the Release Manager builds `RELEASE-NOTES.html`:
  =

@@ -42, +38 @@

  =

  Depending on the size of the reports to handle, you may need to set `ANT_=
OPTS`, for instance to `-Xms100m -Xmx200m`. You may obviously also put `rel=
notes.src.reports` in `ant.properties` if you prefer.
  =

- Please note that the Release Manager should run the JIRA reports to gener=
ate `fixedBugsList.xml` and `releaseNotesList.xml` freshly just before typi=
ng `ant genrelnotes`. This is because, during the release period, new issue=
s may be fixed and included in the release and the text for individual rele=
ase notes may be improved. Stale reports overlook the new issues and improv=
ed notes.
+ Please note that the Release Manager should run the JIRA report to genera=
te `fixedBugsList.xml` freshly just before typing `ant genrelnotes`. The re=
lease manager may need to re-tweak the custom implementation of !ReportPars=
er too. This is because, during the release period, new issues may be fixed=
 and included in the release and the text for individual release notes may =
be improved. Stale reports overlook the new issues and improved notes.
  =

  On Windows when you try to commit you may get the message <code> svn: Inc=
onsistent line ending style </code>. To resolve this Kathey went into emacs=
 and removed the ^M's. Myrna's solution was to jar up RELEASE-NOTES.html, f=
tp to a linux machine, run dos2unix, then unix2dos on the Release notes (i.=
e., saving with a different name each time), jar the release notes back up,=
 ftp back to windows, then commit will work.
 =20