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 MyrnavanLunteren
Date Tue, 06 Sep 2011 22:52:53 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 MyrnavanLunteren:
http://wiki.apache.org/db-derby/ReleaseNoteProcess?action=diff&rev1=19&rev2=20

  
  To generate `RELEASE-NOTES.html`, the Release Manager first prepares the environment:
  
+  * '''Install Maven''' - Install a recent version of Maven and add the bin directory to
your path
   * '''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 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. 
+    * `fixedBugsList.xml` - This is the list of issues addressed by the release. To generate
this file you need to save a filter for the appropriate search 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. 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.
+ 
+ Note: 
+ For versions older than 10.8, these instructions may be different. For instance, at one
point, generating the release notes involves using the class java/build/org/apache/derbyBuild/ReportParser.
You needed to tweak this report 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. For more information on producing this report for older branches, see the header
comment on !ReportParser$April_2010 on a branch that has it.
  
  Then the Release Manager builds `RELEASE-NOTES.html`:
  
  {{{
  cd tools/release
- ant -Drelnotes.src.reports=/path/to/report_directory genrelnotes
+ ant -Drelnotes.src.reports=/path/to/report_directory 
+     -Djira.user=<jira user name>
+     -Djira.password=<password for that user>
+     -Drelease.version=<version of the release in JIRA>
+     -Djira.filter.id=<id of the search filter>
+    genrelnotes
  }}}
+ 
+ If you forget or have not set any of these settings, the release notes build will fail and
you will be informed of which element you've missed.
+ 
+ To find the jira filter id, I saved the JIRA query as a filter, and then used the number
following the id in the url window when the search was issued.
  
  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 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.
+ Please note that the Release Manager should run the JIRA report to generate `fixedBugsList.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.
  
- 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. Lily's solution is run perl command
"perl -p -e 's/\r$//' < RELEASE-NOTES.html > ~/RELEASE-NOTES.html
+ 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 install cygwin's dos2unix & unix2dos and use them in sequence.
Lily's solution is run perl command "perl -p -e 's/\r$//' < RELEASE-NOTES.html > ~/RELEASE-NOTES.html
  

Mime
View raw message