db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Db-derby Wiki] Update of "ReleaseNoteProcess" by RichardHillegas
Date Fri, 18 May 2007 14:16:36 GMT
Dear Wiki user,

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

The following page has been changed by RichardHillegas:

  ## page was renamed from DerbyReleaseNoteProcess
+ '''Table of Contents'''
+ [[TableOfContents(3)]]
+ == Writing a Release Note ==
  Good release notes are essential for users as they upgrade from one release to the next.
Here's the procedure the Derby team uses to maintain useful release notes:
   * For JIRAs which need a release note, you should turn on the "Release Note Needed" flag
and attach a file called "releaseNote.html".
@@ -9, +15 @@

  Some additional discussion regarding this process can be found in DERBY-2570.
+ == Generating the Release Documentation ==
+ As part of producing a Derby release, the Release Manager creates RELEASE-NOTES.html, a
web page which lives in the top directory of the branch codeline, next to the STATUS and CHANGES
files. This file ships with the release distributions and is also incorporated into the release
download page on the Apache website. RELEASE-NOTES.html describes Derby's key capabilities
and it summarizes the delta between the new release and some previous release--usually the
last release produced by the community. The Issues section of RELEASE-NOTES.html includes
the releaseNotes.html files which were attached to significant JIRAs.
+ To generate RELEASE-NOTES.html, the Release Manager first prepares the environment:
+  * '''Build''' - Builds the branch codeline in order to compile the ReleaseNotesGenerator
+  * '''Summarize''' - Fills in a summary of the release. This involves filling 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:
+    * fixedBugsList.xml - This is the list of issues addressed by the release
+    * releaseNotes.xml - This is the list of issues bearing detailed releaseNotes.html explanations.
+ Then the Release Manager builds RELEASE-NOTES.html:
+  * '''relnotes.src.reports''' - In ant.properties, this variable should point at the directory
which holds the two xml JIRA reports.
+  * '''cd''' - Change directory to tools/release.
+  * '''ant''' - Run ant like so: "ant genrelnotes"
+ Please note that the Release Manager should run the JIRA reports freshly just before typing
"ant genrelnotes". 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.

View raw message