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 DyreTjeldvoll
Date Wed, 19 Mar 2008 20:38:15 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 DyreTjeldvoll:
http://wiki.apache.org/db-derby/ReleaseNoteProcess

------------------------------------------------------------------------------
  
  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".
+  * For JIRAs which need a release note, you should turn on the "Release Note Needed" flag
and attach a file called `releaseNote.html`.
-  * The template for `releaseNote.html` lives in `tools/release/templates/releaseNote.html`.

+  * The template for `releaseNote.html` lives in `tools/release/templates/releaseNote.html`
([http://svn.apache.org/repos/asf/db/derby/code/trunk/tools/release/templates/releaseNote.html
svn repos]). 
   * Before attaching your release note, make sure that the release processes can digest it.
Run the lint tool, [https://svn.apache.org/repos/asf/db/derby/code/trunk/java/build/org/apache/derbyBuild/ReleaseNoteReader.java
ReleaseNoteReader], on your note as follows:
   {{{ java org.apache.derbyBuild.ReleaseNoteReader RELEASE_NOTE_FILE
  }}}
@@ -34, +34 @@

   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.
  
  Then the Release Manager builds `RELEASE-NOTES.html`:
+ 
  {{{cd tools/release
  ant -Drelnotes.src.reports=/path/to/report_directory genrelnotes}}}
+ 
-   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.
+ 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.
  

Mime
View raw message