Differences between revisions 14 and 15
Revision 14 as of 2009-07-22 15:46:51
Size: 5052
Comment: After DERBY-3598, need add ant.jar in classpath to run the ReleaseNoteReader
Revision 15 as of 2009-09-20 22:11:21
Size: 5060
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
[[TableOfContents(3)]] <<TableOfContents(3)>>
Line 11: Line 11:
 * 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. Add classes and $ANT_HOME/lib/ant.jar to your classpath and 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:
 * 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. Add classes and $ANT_HOME/lib/ant.jar to your classpath and 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:
Line 18: Line 18:
Some additional discussion regarding this process can be found in [https://issues.apache.org/jira/browse/DERBY-2570 DERBY-2570]. Some additional discussion regarding this process can be found in [[https://issues.apache.org/jira/browse/DERBY-2570|DERBY-2570]].
Line 26: Line 26:
 * '''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.  * '''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.

Table of Contents

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.

  • The template for releaseNote.html lives in tools/release/templates/releaseNote.html (svn repos).

  • Before attaching your release note, make sure that the release processes can digest it. Add classes and $ANT_HOME/lib/ant.jar to your classpath and run the lint tool, 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.
  • As you improve the wording of your release note, you simply attach a new version of releaseNote.html. The release documentation will include the last version of the release note.

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 (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 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:

    • 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.

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.

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.

ReleaseNoteProcess (last edited 2018-03-24 22:43:44 by RichardHillegas)