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:08:06 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".
-  * The template for releaseNote.html lives in tools/release/templates/releaseNote.html.

+  * The template for `releaseNote.html` lives in `tools/release/templates/releaseNote.html`.

-  * 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:
+  * 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
  }}}
   where RELEASE_NOTE_FILE is the name of the file which holds your release note.
@@ -21, +21 @@

  
  == 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.
+ 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` (''up to version 10.3'') 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 [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.
+  * '''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
     * `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.
  
- Then the Release Manager builds RELEASE-NOTES.html:
+ 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.
  
+ 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.
-  * '''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"
-    Depending on the size of the reports to handle, you may need to set ANT_OPTS, for instance
to -Xms100m -Xmx200m
  
- 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.
- 

Mime
View raw message