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 Wed, 21 Apr 2010 20:24:44 GMT
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=diff&rev1=16&rev2=17

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

  
  To generate `RELEASE-NOTES.html`, the Release Manager first prepares the environment:
  
-  * '''Build''' - Builds the branch codeline in order to compile the [[https://svn.apache.org/repos/asf/db/derby/code/trunk/java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java|ReleaseNotesGenerator]]
program. Before doing this, make sure that you edit !JiraIssue.java in order to hardcode the
attachment ids for the issues which have detailed release notes. These attachment 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 [[https://svn.apache.org/repos/asf/db/derby/code/trunk/java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java|ReleaseNotesGenerator]]
program.
   * '''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:
+  * '''Report''' - Generates a JIRA report:
+    * `fixedBugsList.xml` - This is the list of issues addressed by the release. To generate
this file you need to use the appropriate search or filter in Jira. You will typically need
to create a new filter for each release. The criteria for `fixedBugsList.xml` will be something
like fixversion=<branch or all release candidate versions>, resolution=fixed and type=bug.
For more information on producing this report, see the header comment on !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 resulting 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 !ReportParser. That is
because the shape of JIRA reports changes significantly between 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 release
-    * `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 filter in Jira. You
will typically need to create a new filter for each release. The criteria for `fixedBugsList.xml`
will be something like fixversion=<branch or all release candidate versions>, resolution=fixed
and type=bug. 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" above 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 described
below. Each of these reports begins with a DOCTYPE declaration. These declarations point at
a DTD which is not present on your machine; those references choke the release notes generator,
so remove the DOCTYPE declarations 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 `relnotes.src.reports` in `ant.properties`
if you prefer.
  
- Please note that the Release Manager should run the JIRA reports to generate `fixedBugsList.xml`
and `releaseNotesList.xml` 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.
+ Please note that the Release Manager should run the JIRA report to generate `fixedBugsList.xml`
freshly just before typing `ant genrelnotes`. The release manager may need to re-tweak the
custom implementation of !ReportParser 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: Inconsistent
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, ftp 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.
  

Mime
View raw message