Return-Path: 
 <derby-commits-return-7342-apmail-db-derby-commits-archive=db.apache.org@db.apache.org>
Delivered-To: apmail-db-derby-commits-archive@www.apache.org
Received: (qmail 69724 invoked from network); 17 May 2007 14:05:48 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2)
  by minotaur.apache.org with SMTP; 17 May 2007 14:05:48 -0000
Received: (qmail 81589 invoked by uid 500); 17 May 2007 14:05:54 -0000
Delivered-To: apmail-db-derby-commits-archive@db.apache.org
Received: (qmail 81547 invoked by uid 500); 17 May 2007 14:05:53 -0000
Mailing-List: contact derby-commits-help@db.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:derby-commits-help@db.apache.org>
list-unsubscribe: <mailto:derby-commits-unsubscribe@db.apache.org>
List-Post: <mailto:derby-commits@db.apache.org>
Reply-To: "Derby Development" <derby-dev@db.apache.org>
List-Id: <derby-commits.db.apache.org>
Delivered-To: mailing list derby-commits@db.apache.org
Received: (qmail 81533 invoked by uid 99); 17 May 2007 14:05:53 -0000
Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 17 May 2007 07:05:53 -0700
X-ASF-Spam-Status: No, hits=-99.5 required=10.0
	tests=ALL_TRUSTED,NO_REAL_NAME
X-Spam-Check-By: apache.org
Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 17 May 2007 07:05:45 -0700
Received: by eris.apache.org (Postfix, from userid 65534)
	id 7855F1A983E; Thu, 17 May 2007 07:05:25 -0700 (PDT)
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r538929 [2/2] - in /db/derby/code/trunk:
 RELEASE-NOTES.html
 java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java
 releaseSummary.xml tools/release/build.xml
 tools/release/templates/releaseSummaryTemplate.xml
Date: Thu, 17 May 2007 14:05:19 -0000
To: derby-commits@db.apache.org
From: rhillegas@apache.org
X-Mailer: svnmailer-1.1.0
Message-Id: <20070517140525.7855F1A983E@eris.apache.org>
X-Virus-Checked: Checked by ClamAV on apache.org

Added: db/derby/code/trunk/java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java?view=auto&rev=538929
==============================================================================
--- db/derby/code/trunk/java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java (added)
+++ db/derby/code/trunk/java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java Thu May 17 07:05:18 2007
@@ -0,0 +1,1344 @@
+/*
+
+   Derby - Class org.apache.derbyBuild.ReleaseNotesGenerator
+
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+ */
+
+package org.apache.derbyBuild;
+
+import java.io.*;
+import java.net.URL;
+import java.util.ArrayList;
+import javax.xml.parsers.*;
+import javax.xml.transform.*;
+import javax.xml.transform.dom.*;
+import javax.xml.transform.stream.*;
+import org.w3c.dom.*;
+
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.Project;
+import org.apache.tools.ant.Task;
+import org.apache.tools.ant.taskdefs.Echo;
+
+/**
+ * <p>
+ * This tool generates Release Notes for a Derby release. See the USAGE
+ * constant for details on how to run this tool standalone. It is recommended
+ * that you freshly regenerate your BUG_LIST and NOTES_LIST just before
+ * you run this tool.
+ * </p>
+ *
+ * <p>
+ * The tool is designed to be run from Derby's ant build scripts. To run under
+ * ant, do the following:
+ * </p>
+ *
+ * <ul>
+ * <li>Define the "relnotes.src.reports" variable in your ant.properties. This
+ * variable points at the directory which holds your xml JIRA reports.</li>
+ * <li>Put your xml JIRA reports in that directory. They should have the
+ * following names:
+ *  <ul>
+ *  <li>fixedBugsList.xml - This is the list of issues addressed by the release.</li>
+ *  <li>releaseNotesList.xml - This is the list of issues which have detailed
+ *  release notes.</li>
+ *  </ul>
+ * </li>
+ * <li>Then cd to tools/release and run ant thusly: "ant genrelnotes"</li>
+ * </ul>
+ *
+ * <p>For more information on this tool, please see the JIRA which introduced it:
+ * </p>
+ *
+ * <p>
+ * <a href="http://issues.apache.org/jira/browse/DERBY-2570">DERBY-2570</a>
+ * </p>
+ */
+public class ReleaseNotesGenerator extends Task
+{
+    /////////////////////////////////////////////////////////////////////////
+    //
+    //  CONSTANTS
+    //
+    /////////////////////////////////////////////////////////////////////////
+    
+    private static  final   String  USAGE =
+        "Usage:\n" +
+        "\n" +
+        "  java org.apache.derbyBuild.ReleaseNotesGenerator SUMMARY BUG_LIST NOTES_LIST OUTPUT_PAMPHLET\n" +
+        "\n" +
+        "    where\n" +
+        "                  SUMMARY                    Summary, a filled-in copy of releaseSummaryTemplate.xml.\n" +
+        "                  BUG_LIST                     An xml JIRA report of issues addressed by this release.\n" +
+        "                  NOTES_LIST                An xml JIRA report listing issues which have detailed releaseNotes.html attachments.\n" +
+        "                  OUTPUT_PAMPHLET  The output file to generate, typically RELEASE-NOTES.html.\n" +
+        "\n" +
+        "The ReleaseNoteGenerator attempts to connect to issues.apache.org in\n" +
+        "order to read the detailed release notes that have been clipped to\n" +
+        "individual JIRAs. Before running this program, make sure that you can\n" +
+        "ping issues.apache.org.\n" +
+        "\n" +
+        "The ReleaseNoteGenerator assumes that the two JIRA reports contain\n" +
+        "key, title, and attachments elements for each Derby issue. For each\n" +
+        "issue in NOTES_LIST, the ReleaseNotesGenerator looks through the\n" +
+        "attachments block in that report and grabs the latest reported\n" +
+        "releaseNote.html.\n" +
+        "\n" +
+        "For this reason, it is recommended that you freshly generate BUG_LIST\n" +
+        "and NOTES_LIST just before you run this tool.\n"
+        ;
+
+    // header levels
+    private static  final   int     BANNER_LEVEL = 1;
+    private static  final   int     MAIN_SECTION_LEVEL = BANNER_LEVEL + 1;
+    private static  final   int     ISSUE_DETAIL_LEVEL = MAIN_SECTION_LEVEL + 1;
+    
+    // major sections
+    private static  final   String  OVERVIEW_SECTION = "Overview";
+    private static  final   String  NEW_FEATURES_SECTION = "New Features";
+    private static  final   String  BUG_FIXES_SECTION = "Bug Fixes";
+    private static  final   String  ISSUES_SECTION = "Issues";
+    private static  final   String  BUILD_ENVIRONMENT_SECTION = "Build Environment";
+
+    // headlines
+    private static  final   String  ANT_HEADLINE = "Ant";
+    private static  final   String  BRANCH_HEADLINE = "Branch";
+    private static  final   String  COMPILER_HEADLINE = "Compiler";
+    private static  final   String  DESCRIPTION_HEADLINE = "Description";
+    private static  final   String  ISSUE_ID_HEADLINE = "Issue Id";
+    private static  final   String  JAVA6_HEADLINE = "Java 6";
+    private static  final   String  JDK14_HEADLINE = "JDK 1.4";
+    private static  final   String  JSR169_HEADLINE = "JSR 169";
+    private static  final   String  MACHINE_HEADLINE = "Machine";
+    private static  final   String  OSGI_HEADLINE = "OSGi";
+
+    // formatting tags
+    private static  final   String  ANCHOR = "a";
+    private static  final   String  BODY = "body";
+    private static  final   String  BOLD = "b";
+    private static  final   String  BORDER = "border";
+    private static  final   String  COLUMN = "td";
+    private static  final   String  HORIZONTAL_LINE = "hr";
+    private static  final   String  HTML = "html";
+    private static  final   String  INDENT = "blockquote";
+    private static  final   String  LIST = "ul";
+    private static  final   String  LIST_ELEMENT = "li";
+    private static  final   String  NAME = "name";
+    private static  final   String  PARAGRAPH = "p";
+    private static  final   String  ROW = "tr";
+    private static  final   String  TABLE = "table";
+
+    // tags in summary xml
+    private static  final   String  SUM_ANT_VERSION = "antVersion";
+    private static  final   String  SUM_BRANCH = "branch";
+    private static  final   String  SUM_COMPILER = "compilers";
+    private static  final   String  SUM_JAVA6 = "java6";
+    private static  final   String  SUM_JDK14 = "jdk1.4";
+    private static  final   String  SUM_JSR169 = "jsr169";
+    private static  final   String  SUM_MACHINE = "machine";
+    private static  final   String  SUM_NEW_FEATURES = "newFeatures";
+    private static  final   String  SUM_OSGI = "osgi";
+    private static  final   String  SUM_OVERVIEW = "overview";
+    private static  final   String  SUM_PREVIOUS_RELEASE_ID = "previousReleaseID";
+    private static  final   String  SUM_RELEASE_ID = "releaseID";
+
+    // tags in JIRA reports
+    private static  final   String  JIRA_ATTACHMENT = "attachment";
+    private static  final   String  JIRA_ATTACHMENTS = "attachments";
+    private static  final   String  JIRA_ID = "id";
+    private static  final   String  JIRA_ITEM = "item";
+    private static  final   String  JIRA_KEY = "key";
+    private static  final   String  JIRA_NAME = "name";
+    private static  final   String  JIRA_TITLE = "title";
+
+    // managing releaseNote.html
+    private static  final   String  RN_SUMMARY_OF_CHANGE = "Summary of Change";
+
+    // other JIRA control
+    private static  final   String  RELEASE_NOTE_NAME = "releaseNote.html";
+    private static  final   String  RN_H4 = "h4";
+    
+    // other html control
+    private static  final   int     DEFAULT_TABLE_BORDER_WIDTH = 2;
+    private static  final   String  XML_DECLARATION = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
+    
+    /////////////////////////////////////////////////////////////////////////
+    //
+    //  STATE
+    //
+    /////////////////////////////////////////////////////////////////////////
+
+    // set on the command line or by ant
+    private String  _summaryFileName;
+    private String  _bugListFileName;
+    private String  _releaseNotesListFileName;
+    private String  _pamphletFileName;
+
+    // computed at run time
+    private String  _releaseID;
+    private String  _previousReleaseID;
+
+    // misc
+    private boolean _invokedByAnt = true;
+    
+    /////////////////////////////////////////////////////////////////////////
+    //
+    //  INNER CLASSES
+    //
+    /////////////////////////////////////////////////////////////////////////
+
+    /**
+     * <p>
+     * State used by the generator
+     * </p>
+     */
+    public  static  class   GeneratorState
+    {
+        private DocumentBuilder _documentBuilder;
+        private Document    _pamphlet;
+        private Document    _summary;
+        private Document    _bugList;
+        private Document    _releaseNotesList;
+
+        private ArrayList       _missingReleaseNotes;
+
+        public  GeneratorState
+            (
+             DocumentBuilder    documentBuilder,
+             Document   pamphlet,
+             Document   summary,
+             Document   bugList,
+             Document   releaseNotesList
+             )
+        {
+            _documentBuilder = documentBuilder;
+            _pamphlet = pamphlet;
+            _summary = summary;
+            _bugList = bugList;
+            _releaseNotesList = releaseNotesList;
+
+            _missingReleaseNotes = new ArrayList();
+        }
+
+        public  void    addMissingReleaseNote( JiraIssue issue )
+        {
+            _missingReleaseNotes.add( issue );
+        }
+
+        public  DocumentBuilder getDocumentBuilder() { return _documentBuilder; }
+        public  Document    getPamphlet() { return _pamphlet; }
+        public  Document    getSummary() { return _summary; }
+        public  Document    getBugList() { return _bugList; }
+        public  Document    getReleaseNotesList() { return _releaseNotesList; }
+        
+        public  JiraIssue[]     getMissingReleaseNotes()
+        {
+            JiraIssue[]     missingNotes = new JiraIssue[ _missingReleaseNotes.size() ];
+
+            _missingReleaseNotes.toArray( missingNotes );
+
+            return missingNotes;
+        }
+    }
+
+    /**
+     * <p>
+     * An issue from a JIRA report.
+     * </p>
+     */
+    public  static  class   JiraIssue
+    {
+        public  static  final   long NO_RELEASE_NOTE = -1L;
+
+        private String  _key;
+        private String  _title;
+        private long         _releaseNoteAttachmentID;
+
+        public  JiraIssue
+            (
+             String key,
+             String title,
+             long       releaseNoteAttachmentID
+             )
+        {
+            _key = key;
+            _title = title;
+            _releaseNoteAttachmentID = releaseNoteAttachmentID;
+        }
+
+        public  String  getKey() { return _key; }
+        public  String  getTitle() { return _title; }
+        public  long         getReleaseNoteAttachmentID() { return _releaseNoteAttachmentID; }
+        public  boolean hasReleaseNote() { return (_releaseNoteAttachmentID > NO_RELEASE_NOTE); }
+        
+        public  String  getJiraAddress()
+        {
+            return "http://issues.apache.org/jira/browse/" + _key;
+        }
+
+        public  String  getReleaseNoteAddress()
+        {
+            return "http://issues.apache.org/jira/secure/attachment/" + _releaseNoteAttachmentID + "/releaseNote.html";
+        }
+    }
+    
+    /////////////////////////////////////////////////////////////////////////
+    //
+    //  CONSTRUCTORS
+    //
+    /////////////////////////////////////////////////////////////////////////
+
+    /////////////////////////////////////////////////////////////////////////
+    //
+    //  ENTRY POINT
+    //
+    /////////////////////////////////////////////////////////////////////////
+
+    /**
+     * <p>
+     * Generate the release notes (for details on how to invoke this tool, see
+     * the header comment on this class).
+     * </p>
+     */
+    public  static  void    main( String[] args )
+        throws Exception
+    {
+        ReleaseNotesGenerator   me = new ReleaseNotesGenerator();
+
+        me._invokedByAnt = false;
+        
+        if ( me.parseArgs( args ) ) { me.execute(); }
+        else { me.printUsage(); }
+    }
+    
+    /////////////////////////////////////////////////////////////////////////
+    //
+    //  ANT Task BEHAVIOR
+    //
+    /////////////////////////////////////////////////////////////////////////
+
+    /** Ant accessor to set the name of the summary file prepared by the Release Manager */
+    public   void    setSummaryFileName( String summaryFileName ) { _summaryFileName = summaryFileName; }     
+
+    /** Ant accessor to set the name of the JIRA-generated list of bugs addressed by this release */
+    public   void    setBugListFileName( String bugListFileName ) { _bugListFileName = bugListFileName; }     
+
+    /** Ant accessor to set the name of the JIRA-generated list of bugs which have release notes */
+    public   void    setReleaseNotesListFileName( String releaseNotesListFileName ) { _releaseNotesListFileName = releaseNotesListFileName; }     
+
+    /** Ant accessor to set the name of the generated output file */
+    public   void    setPamphletFileName( String pamphletFileName ) { _pamphletFileName = pamphletFileName; }     
+        
+    /**
+     * <p>
+     * This is Ant's entry point into this task.
+     * </p>
+     */
+    public  void    execute()
+        throws BuildException
+    {
+        try {
+            GeneratorState                  gs = initialize();
+
+            beginPamphlet( gs );
+            buildOverview( gs );
+            buildNewFeatures( gs );
+            buildBugList( gs );
+            buildIssuesList( gs );
+            buildEnvironment( gs );
+            endPamphlet( gs );
+            
+            printPamphlet( gs );
+
+            printMissingReleaseNotes( gs );
+        }
+        catch ( Throwable t )
+        {
+            t.printStackTrace();
+            
+            throw new BuildException( "Error running ReleaseNotesGenerator: " + t.getMessage(), t );
+        }
+    }
+    
+    /////////////////////////////////////////////////////////////////////////
+    //
+    //  OTHER ACCESSORS
+    //
+    /////////////////////////////////////////////////////////////////////////
+
+    /**
+     * <p>
+     * Get the release ID from the summary file.
+     * </p>
+     */
+    private String getReleaseID( GeneratorState gs)
+        throws Exception
+    {
+        if ( _releaseID == null )
+        {
+            Document    summary = gs.getSummary();
+            Element     summaryRoot = summary.getDocumentElement();
+            
+            _releaseID = squeezeText( getFirstChild( summaryRoot, SUM_RELEASE_ID ) );
+        }
+        
+        return _releaseID;
+    }
+    
+    /**
+     * <p>
+     * Get the previous release ID from the summary file.
+     * </p>
+     */
+    private String getPreviousReleaseID( GeneratorState gs)
+        throws Exception
+    {
+        if ( _previousReleaseID == null )
+        {
+            Document    summary = gs.getSummary();
+            Element     summaryRoot = summary.getDocumentElement();
+            
+            _previousReleaseID = squeezeText( getFirstChild( summaryRoot, SUM_PREVIOUS_RELEASE_ID ) );
+        }
+        
+        return _previousReleaseID;
+    }
+    
+    /////////////////////////////////////////////////////////////////////////
+    //
+    //  MINIONS
+    //
+    /////////////////////////////////////////////////////////////////////////
+
+    //////////////////////////////////
+    //
+    //  Boilerplate
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Start an html docment. Returns the body element.
+     * </p>
+     */
+    private void beginPamphlet( GeneratorState gs )
+        throws Exception
+    {
+        Document    pamphlet = gs.getPamphlet();
+        String          releaseID = getReleaseID( gs );
+        String          titleText = "Release Notes for Derby " + releaseID;
+        Element     html = pamphlet.createElement( HTML );
+        Element     title = createTextElement( pamphlet, "title", titleText );
+        Element     body = pamphlet.createElement( BODY );
+
+        pamphlet.appendChild( html );
+        html.appendChild( title );
+        html.appendChild( body );
+        
+        Element     bannerBlock = createHeader( body, BANNER_LEVEL, titleText );
+        buildDelta( gs, bannerBlock );
+        
+        Element     toc = createList( body );
+
+        createSection( body, MAIN_SECTION_LEVEL, toc, OVERVIEW_SECTION, null );
+        createSection( body, MAIN_SECTION_LEVEL, toc, NEW_FEATURES_SECTION, null );
+        createSection( body, MAIN_SECTION_LEVEL, toc, BUG_FIXES_SECTION, null );
+        createSection( body, MAIN_SECTION_LEVEL, toc, ISSUES_SECTION, null );
+        createSection( body, MAIN_SECTION_LEVEL, toc, BUILD_ENVIRONMENT_SECTION, null );
+    }
+    
+    /**
+     * <p>
+     * Finish the html document.
+     * </p>
+     */
+    private void    endPamphlet( GeneratorState gs )
+        throws Exception
+    {
+    }
+    
+    //////////////////////////////////
+    //
+    //  Delta SECTION
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Note that this release is a delta from the previous one.
+     * </p>
+     */
+    private void buildDelta( GeneratorState gs, Element parent )
+        throws Exception
+    {
+        String          releaseID = getReleaseID( gs );
+        String          previousReleaseID = getPreviousReleaseID( gs );
+        String          deltaStatement =
+            "These notes describe the difference between Derby release " + releaseID +
+            " and the preceding release " + previousReleaseID + ".";
+
+        addParagraph( parent, deltaStatement );
+    }
+    
+    //////////////////////////////////
+    //
+    //  Overview SECTION
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Build the Overview section.
+     * </p>
+     */
+    private void buildOverview( GeneratorState gs )
+        throws Exception
+    {
+        Document    pamphlet = gs.getPamphlet();
+        Element     overviewSection = getSection( pamphlet, MAIN_SECTION_LEVEL, OVERVIEW_SECTION );
+        Document    summary = gs.getSummary();
+        Element     summaryRoot = summary.getDocumentElement();
+        Element     details = getFirstChild( summaryRoot, SUM_OVERVIEW );
+
+        // copy the details out of the summary file into the overview section
+        cloneChildren( details, overviewSection );
+    }
+    
+    //////////////////////////////////
+    //
+    //  New Features SECTION
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Build the New Features section.
+     * </p>
+     */
+    private void buildNewFeatures( GeneratorState gs )
+        throws Exception
+    {
+        Document    pamphlet = gs.getPamphlet();
+        Element     newFeaturesSection = getSection( pamphlet, MAIN_SECTION_LEVEL, NEW_FEATURES_SECTION );
+        Document    summary = gs.getSummary();
+        Element     summaryRoot = summary.getDocumentElement();
+        Element     details = getFirstChild( summaryRoot, SUM_NEW_FEATURES );
+
+        // copy the details out of the summary file into the overview section
+        cloneChildren( details, newFeaturesSection );
+    }
+    
+    //////////////////////////////////
+    //
+    //  Bug List SECTION
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Build the Bug List section.
+     * </p>
+     */
+    private void buildBugList( GeneratorState gs )
+        throws Exception
+    {
+        Document    pamphlet = gs.getPamphlet();
+        Element     bugListSection = getSection( pamphlet, MAIN_SECTION_LEVEL, BUG_FIXES_SECTION );
+        Document    bugList = gs.getBugList();
+        JiraIssue[]    bugs = getJiraIssues( bugList );
+        int                 count = bugs.length;
+        String          releaseID = getReleaseID( gs );
+        String          previousReleaseID = getPreviousReleaseID( gs );
+        String          deltaStatement =
+            "The following issues are addressed by Derby release " + releaseID +
+            ". These issues are not addressed in the preceding " + previousReleaseID + " release.";
+
+        addParagraph( bugListSection, deltaStatement );
+
+        Element     table = createTable
+            ( bugListSection, DEFAULT_TABLE_BORDER_WIDTH, new String[] { ISSUE_ID_HEADLINE, DESCRIPTION_HEADLINE } );
+
+        for ( int i = 0; i < count; i++ )
+        {
+            JiraIssue   issue = bugs[ i ];
+            Element     row = insertRow( table );
+            Element     linkColumn = insertColumn( row );
+            Element     descriptionColumn = insertColumn( row );
+            Element     hotlink = createLink( pamphlet, issue.getJiraAddress(), issue.getKey() );
+            Text            title = pamphlet.createTextNode( issue.getTitle() );
+
+            linkColumn.appendChild( hotlink );
+            descriptionColumn.appendChild( title );
+        }
+    }
+    
+    //////////////////////////////////
+    //
+    //  Issues SECTION
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Build the Issues section.
+     * </p>
+     */
+    private void buildIssuesList( GeneratorState gs )
+        throws Exception
+    {
+        Document    pamphlet = gs.getPamphlet();
+        Element     issuesSection = getSection( pamphlet, MAIN_SECTION_LEVEL, ISSUES_SECTION );
+        Document    issuesList = gs.getReleaseNotesList();
+        JiraIssue[]    bugs = getJiraIssues( issuesList );
+        int                 count = bugs.length;
+        String          releaseID = getReleaseID( gs );
+        String          previousReleaseID = getPreviousReleaseID( gs );
+        String          deltaStatement =
+            "Compared with the previous release (" + previousReleaseID +
+            "), Derby release " + releaseID + " introduces the following new features " +
+            "and incompatibilities. These merit your special attention.";
+        
+        addParagraph( issuesSection, deltaStatement );
+
+        Element     toc = createList( issuesSection );
+
+        for ( int i = 0; i < count; i++ )
+        {
+            JiraIssue       issue = bugs[ i ];
+            Document    releaseNote = getReleaseNote( gs, issue );
+            String          key = "Note for " + issue.getKey();
+            String          summary = getReleaseNoteSummary( releaseNote );
+            String          tocEntry = key + ": " + summary;
+
+            insertLine( issuesSection );
+            
+            Element     issueSection = createSection( issuesSection, ISSUE_DETAIL_LEVEL, toc, key, tocEntry );
+
+            if ( releaseNote != null )
+            {
+                Element     root = releaseNote.getDocumentElement();
+                Element     details = getFirstChild( root, BODY );
+
+                // copy the details out of the release note into this section of the
+                // pamphlet
+                cloneChildren( details, issueSection );
+            }
+            else
+            {
+                gs.addMissingReleaseNote( issue );
+            }
+
+        }
+    }
+    
+    /**
+     * <p>
+     * Get the release note for an issue.
+     * </p>
+     */
+    private Document   getReleaseNote( GeneratorState gs, JiraIssue issue )
+        throws Exception
+    {
+        if ( issue.hasReleaseNote() )
+        {
+            URL                                 url = new URL( issue.getReleaseNoteAddress() );
+
+            try {
+                InputStream                     is = url.openStream();
+                Document        doc = gs.getDocumentBuilder().parse( is );
+
+                is.close();
+
+                return doc;
+            }
+            catch (Exception e)
+            {
+                processThrowable( e );
+                
+                throw new BuildException
+                    ( "Unable to read or parse release note for " + issue.getKey() + ": " + e.toString(), e );
+            }
+        }
+        else { return null; }
+    }
+
+    /**
+     * <p>
+     * Get the summary for a release note
+     * </p>
+     */
+    private String   getReleaseNoteSummary( Document releaseNote )
+        throws Exception
+    {
+        if ( releaseNote != null )
+        {
+            //
+            // The release note has the following structure:
+            //
+            // <h4>Summary of Change</h4>
+            // <p>
+            //  Summary text
+            // </p>
+            //
+            Element     root = releaseNote.getDocumentElement();
+            Element     summaryParagraph = getFirstChild( root, PARAGRAPH );
+            String          summaryText = squeezeText( summaryParagraph );
+
+            return summaryText;
+        }
+        else { return "???"; }
+    }
+
+    //////////////////////////////////
+    //
+    //  Build Environment SECTION
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Build the section describing the build environment.
+     * </p>
+     */
+    private void buildEnvironment( GeneratorState gs )
+        throws Exception
+    {
+        Document    pamphlet = gs.getPamphlet();
+        Element         environmentSection = getSection( pamphlet, MAIN_SECTION_LEVEL, BUILD_ENVIRONMENT_SECTION );
+        Document    summary = gs.getSummary();
+        Element     summaryRoot = summary.getDocumentElement();
+        String          releaseID = getReleaseID( gs );
+        String          desc = "Derby release " + releaseID + " was built using the following environment:";
+
+        addParagraph( environmentSection, desc );
+
+        Element     list = createList( environmentSection );
+        String          branchName = squeezeText( getFirstChild( summaryRoot, SUM_BRANCH ) );
+        String          branchText = "Source code came from the " + branchName + " branch.";
+        addHeadlinedItem( list, BRANCH_HEADLINE, branchText );
+
+        String          machine = squeezeText( getFirstChild( summaryRoot, SUM_MACHINE ) );
+        addHeadlinedItem( list, MACHINE_HEADLINE, machine );
+
+        String          antVersion = squeezeText( getFirstChild( summaryRoot, SUM_ANT_VERSION ) );
+        addHeadlinedItem( list, ANT_HEADLINE, antVersion );
+
+        String          jdk14Version = squeezeText( getFirstChild( summaryRoot, SUM_JDK14 ) );
+        addHeadlinedItem( list, JDK14_HEADLINE, jdk14Version );
+
+        String          java6Version = squeezeText( getFirstChild( summaryRoot, SUM_JAVA6 ) );
+        addHeadlinedItem( list, JAVA6_HEADLINE, java6Version );
+
+        String          osgiText = squeezeText( getFirstChild( summaryRoot, SUM_OSGI ) );
+        addHeadlinedItem( list, OSGI_HEADLINE, osgiText );
+
+        String          compilerText = squeezeText( getFirstChild( summaryRoot, SUM_COMPILER ) );
+        addHeadlinedItem( list, COMPILER_HEADLINE, compilerText );
+
+        String          jsr169Text = squeezeText( getFirstChild( summaryRoot, SUM_JSR169 ) );
+        addHeadlinedItem( list, JSR169_HEADLINE, jsr169Text );
+    }
+    
+   //////////////////////////////////
+    //
+    //  Print the generated document.
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Print pamphlet to output file.
+     * </p>
+     */
+    private void    printPamphlet( GeneratorState gs )
+        throws Exception
+    {
+        Document    pamphlet = gs.getPamphlet();
+        Source            source = new DOMSource( pamphlet );
+        File                  outputFile = new File( _pamphletFileName );
+        Result            result = new StreamResult( outputFile );
+        Transformer   transformer = TransformerFactory.newInstance().newTransformer();
+        
+        transformer.transform( source, result );        
+    }
+    
+    //////////////////////////////////
+    //
+    //  Print missing Release Notes
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Build the Overview section.
+     * </p>
+     */
+    private void printMissingReleaseNotes( GeneratorState gs )
+        throws Exception
+    {
+        JiraIssue[]     missingReleaseNotes = gs.getMissingReleaseNotes();
+        int                 count = missingReleaseNotes.length;
+
+        if ( count > 0 )
+        {
+            println( "The following JIRA issues still need release notes:" );
+
+            for ( int i = 0; i < count; i++ )
+            {
+                JiraIssue   issue = missingReleaseNotes[ i ];
+                
+                println( "\t" + issue.getKey() + "\t" + issue.getTitle() );
+            }
+        }
+    }
+    
+    //////////////////////////////////
+    //
+    //  ARGUMENT MINIONS
+    //
+    //////////////////////////////////
+
+    /**
+     * <p>
+     * Returns true if arguments parse successfully, false otherwise.
+     * </p>
+     */
+    private boolean    parseArgs( String[] args )
+        throws Exception
+    {
+        if ( (args == null) || (args.length != 4) ) { return false; }
+
+        int     idx = 0;
+
+        setSummaryFileName( args[ idx++ ] );
+        setBugListFileName( args[ idx++ ] );
+        setReleaseNotesListFileName( args[ idx++ ] );
+        setPamphletFileName( args[ idx++ ] );
+
+        return true;
+    }
+    
+    private void    printUsage()
+    {
+        println( USAGE );
+    }
+
+    /**
+     * <p>
+     * Make sure that the input files all exist. Returns a state variable for the generator.
+     * </p>
+     */
+    private GeneratorState  initialize()
+        throws Exception
+    {
+        DocumentBuilderFactory  factory = DocumentBuilderFactory.newInstance();
+        DocumentBuilder              builder = factory.newDocumentBuilder();
+        Document                          pamphlet = builder.newDocument();
+        File                                    summaryFile = new File( _summaryFileName );
+        File                                    bugListFile = new File( _bugListFileName );
+        File                                    releaseNotesListFile = new File( _releaseNotesListFileName);
+        Document                        summary = builder.parse( summaryFile );
+        Document                        bugList = builder.parse( bugListFile );
+        Document                        releaseNotesList = builder.parse( releaseNotesListFile );
+        
+        return new GeneratorState
+            (
+             builder,
+             pamphlet,
+             summary,
+             bugList,
+             releaseNotesList
+             );
+    }
+
+    ////////////////////////////////////////////////////////
+    //
+    // HTML MINIONS
+    //
+    ////////////////////////////////////////////////////////
+
+    /**
+     * <p>
+     * Create a section at the end of a parent element and link to it from a
+     * table of contents.
+     * </p>
+     */
+    private Element createSection( Element parent, int sectionLevel, Element toc, String sectionName, String tocEntry )
+        throws Exception
+    {
+        Document        doc = parent.getOwnerDocument();
+        Element             link = createLocalLink( doc, sectionName, tocEntry );
+
+        addListItem( toc, link );
+
+        return createHeader( parent, sectionLevel, sectionName );
+    }
+    
+    /**
+     * <p>
+     * Create a header at the end of the parent node. Return the block created
+     * to hold the text following this header.
+     * </p>
+     */
+    private Element createHeader( Element parent, int headerLevel, String text )
+        throws Exception
+    {
+        Document        doc = parent.getOwnerDocument();
+        Text            textNode = doc.createTextNode( text );
+        Element         header = doc.createElement( makeHeaderTag( headerLevel ) );
+        Element         anchor = doc.createElement( ANCHOR );
+        Element         block =doc.createElement( INDENT );
+
+        parent.appendChild( header );
+        anchor.setAttribute( NAME, text );
+        header.appendChild( anchor );
+        header.appendChild( textNode );
+        parent.appendChild( block );
+        
+        return block;
+    }
+    
+    /**
+     * <p>
+     * Create an html text element.
+     * </p>
+     */
+    private Element createTextElement( Document doc, String tag, String text )
+        throws Exception
+    {
+        Element     retval = doc.createElement( tag );
+        Text            textNode = doc.createTextNode( text );
+
+        retval.appendChild( textNode );
+        
+        return retval;
+    }
+
+    /**
+     * <p>
+     * Create a standard link to a local label.
+     * </p>
+     */
+    private Element createLocalLink( Document doc, String anchor, String text )
+        throws Exception
+    {
+        if ( text == null ) { text = anchor; }
+        
+        return createLink( doc, "#" + anchor, text );
+    }
+    
+    /**
+     * <p>
+     * Create a hotlink.
+     * </p>
+     */
+    private Element createLink( Document doc, String label, String text )
+        throws Exception
+    {
+        Element hotlink = doc.createElement( ANCHOR );
+        Text        textNode = doc.createTextNode( text );
+
+        hotlink.setAttribute( "href", label );
+        hotlink.appendChild( textNode );
+
+        return hotlink;
+    }
+    
+    /**
+     * <p>
+     * Insert a list at the end of the parent element.
+     * </p>
+     */
+    private Element createList( Element parent )
+        throws Exception
+    {
+        Document        doc = parent.getOwnerDocument();
+        Element list = doc.createElement( LIST );
+
+        parent.appendChild( list );
+
+        return list;
+    }
+    
+    /**
+     * <p>
+     * Add an item with a bold name to the end of a list.
+     * </p>
+     */
+    private Element addHeadlinedItem( Element list, String headline, String text )
+        throws Exception
+    {
+        Document        doc = list.getOwnerDocument();
+        Element         itemElement = doc.createElement( LIST_ELEMENT );
+        Element         boldText = boldText( doc, headline );
+        Text            textNode = doc.createTextNode( " - " + text );
+
+        list.appendChild( itemElement );
+        itemElement.appendChild( boldText );
+        itemElement.appendChild( textNode );
+
+        return itemElement;
+    }
+    
+    /**
+     * <p>
+     * Make some bold text.
+     * </p>
+     */
+    private Element boldText( Document doc, String text)
+        throws Exception
+    {
+        Element bold = createTextElement( doc, BOLD, text );
+
+        return bold;
+    }
+    
+    /**
+     * <p>
+     * Add an item to the end of a list.
+     * </p>
+     */
+    private Element addListItem( Element list, Node item )
+        throws Exception
+    {
+        Document        doc = list.getOwnerDocument();
+        Element         itemElement = doc.createElement( LIST_ELEMENT );
+
+        list.appendChild( itemElement );
+        itemElement.appendChild( item );
+
+        return itemElement;
+    }
+    
+    /**
+     * <p>
+     * Retrieve the indented block inside a section
+     * </p>
+     */
+    private Element getSection( Document doc, int sectionLevel, String sectionName )
+        throws Exception
+    {
+        String          headerTag = makeHeaderTag( sectionLevel );
+        Element     root = doc.getDocumentElement();
+        NodeList    sectionList = root.getElementsByTagName( headerTag );
+        int             count = sectionList.getLength();
+
+        for ( int i = 0; i < count; i++ )
+        {
+            Element     section = (Element) sectionList.item( i );
+            Element     sectionAnchor = getFirstChild( section, ANCHOR );
+
+            if ( sectionName.equals( sectionAnchor.getAttribute( NAME ) ) )
+            {
+                // the next item after the section header, is the indented block
+
+                return (Element) section.getNextSibling();
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * <p>
+     * Make the tag for a header, given its level
+     * </p>
+     */
+    private String makeHeaderTag( int headerLevel )
+    {
+        return "h" + Integer.toString( headerLevel );
+    }
+    
+    /**
+     * <p>
+     * Add a paragraph to the end of a parent element.
+     * </p>
+     */
+    private Element addParagraph( Element parent, String text )
+        throws Exception
+    {
+        Document        doc = parent.getOwnerDocument();
+        Text            textNode = doc.createTextNode( text );
+        Element         paragraph = doc.createElement( PARAGRAPH );
+
+        parent.appendChild( paragraph );
+        paragraph.appendChild( textNode );
+        
+        return paragraph;
+    }
+    
+    /**
+     * <p>
+     * Insert a table at the end of the parent element.
+     * </p>
+     */
+    private Element createTable( Element parent, int borderWidth, String[] columnHeadings )
+        throws Exception
+    {
+        Document        doc = parent.getOwnerDocument();
+        Element         table = doc.createElement( TABLE );
+        Element         headingRow = insertRow( table );
+        int                     count = columnHeadings.length;
+
+        parent.appendChild( table );
+        table.setAttribute( BORDER, Integer.toString( borderWidth ) );
+
+        for ( int i = 0; i < count; i++ )
+        {
+            Element     headingColumn = insertColumn( headingRow );
+            Element     boldText = boldText( doc, columnHeadings[ i ] );
+
+            headingColumn.appendChild( boldText );
+        }
+
+        return table;
+    }
+    
+    /**
+     * <p>
+     * Insert a row at the end of a table
+     * </p>
+     */
+    private Element insertRow( Element table )
+        throws Exception
+    {
+        Document        doc = table.getOwnerDocument();
+        Element         row = doc.createElement( ROW );
+
+        table.appendChild( row );
+
+        return row;
+    }
+    
+    /**
+     * <p>
+     * Insert a column at the end of a row
+     * </p>
+     */
+    private Element insertColumn( Element row )
+        throws Exception
+    {
+        Document        doc = row.getOwnerDocument();
+        Element         column = doc.createElement( COLUMN );
+
+        row.appendChild( column );
+
+        return column;
+    }
+    
+    /**
+     * <p>
+     * Insert a horizontal line at the end of the parent element.
+     * </p>
+     */
+    private Element insertLine( Element parent )
+        throws Exception
+    {
+        Document        doc = parent.getOwnerDocument();
+        Element         line = doc.createElement( HORIZONTAL_LINE );
+
+        parent.appendChild( line );
+
+        return line;
+    }
+
+    ////////////////////////////////////////////////////////
+    //
+    // XML MINIONS
+    //
+    ////////////////////////////////////////////////////////
+
+    private Element getFirstChild( Element node, String childName )
+        throws Exception
+    {
+        Element retval = getOptionalChild( node, childName );
+
+        if ( retval == null )
+        {
+            throw new BuildException( "Could not find child element '" + childName + "' in parent element '" + node.getNodeName() + "'." );
+        }
+
+        return retval;
+    }
+
+    private Element getOptionalChild( Element node, String childName )
+        throws Exception
+    {
+        return (Element) node.getElementsByTagName( childName ).item( 0 );
+    }
+
+    /**
+     * <p>
+     * Squeeze the text out of an Element.
+     * </p>
+     */
+    private String squeezeText( Element node )
+        throws Exception
+    {
+        Node        textChild = node.getFirstChild();
+        String      text = textChild.getNodeValue();
+
+        return text;
+    }
+
+    /**
+     * <p>
+     * Clone all of the children of a source node and add them as children
+     * of a target node.
+     * </p>
+     */
+    private void cloneChildren( Element source, Element target )
+        throws Exception
+    {
+        Document    targetDoc = target.getOwnerDocument();
+        NodeList        sourceChildren = source.getChildNodes();
+        int                 count = sourceChildren.getLength();
+
+        for ( int i = 0; i < count; i++ )
+        {
+            Node    sourceChild = sourceChildren.item( i );
+            Node    targetChild = targetDoc.importNode( sourceChild, true );
+
+            target.appendChild( targetChild );
+        }
+    }
+
+    ////////////////////////////////////////////////////////
+    //
+    // JIRA MINIONS
+    //
+    ////////////////////////////////////////////////////////
+
+    /**
+     * <p>
+     * Get an array of JiraIssues from a JIRA report.
+     * </p>
+     */
+    private JiraIssue[]   getJiraIssues( Document report )
+        throws Exception
+    {
+        Element         reportRoot = report.getDocumentElement();
+        NodeList        itemList = reportRoot.getElementsByTagName( JIRA_ITEM );
+        int                 count = itemList.getLength();
+        JiraIssue[]     issues = new JiraIssue[ count ];
+
+        for ( int i = 0; i < count; i++ ) { issues[ i ] = makeJiraIssue( (Element) itemList.item( i ) ); }
+
+        return issues;
+    }
+
+    /**
+     * <p>
+     * Create a JiraIssue from an <item> element in a JIRA report.
+     * </p>
+     */
+    private JiraIssue   makeJiraIssue( Element itemElement )
+        throws Exception
+    {
+        String  key = squeezeText( getFirstChild( itemElement, JIRA_KEY ) );
+        String  title = squeezeText( getFirstChild( itemElement, JIRA_TITLE ) );
+        long         releaseNoteAttachmentID = getReleaseNoteAttachmentID( itemElement );
+
+        //
+        // A JIRA title has the following form:
+        //
+        //  "[DERBY-2598] new upgrade  test failures after change 528033"
+        //
+        // We strip off the leading JIRA id because that information already
+        // lives in the key.
+        //
+        title = title.substring( title.indexOf( ']' ) + 2, title.length() );        
+
+        return new JiraIssue( key, title, releaseNoteAttachmentID );
+    }
+
+    /**
+     * <p>
+     * Get the highest attachment id of all of the "releaseNote.html" documents
+     * attached to this JIRA.
+     * </p>
+     */
+    private long   getReleaseNoteAttachmentID( Element itemElement )
+        throws Exception
+    {
+        long         releaseNoteAttachmentID = JiraIssue.NO_RELEASE_NOTE;
+
+        Element     attachments = getOptionalChild( itemElement, JIRA_ATTACHMENTS );
+
+        if ( attachments != null )
+        {
+            NodeList    attachmentsList = attachments.getElementsByTagName( JIRA_ATTACHMENT );
+            int             count = attachmentsList.getLength();
+
+            for ( int i = 0; i < count; i++ )
+            {
+                Element     attachment = (Element) attachmentsList.item( i );
+                String          name = attachment.getAttribute( JIRA_NAME );
+
+                if ( RELEASE_NOTE_NAME.equals( name ) )
+                {
+                    String      stringID = attachment.getAttribute( JIRA_ID );
+                    int             id = Long.decode( stringID ).intValue();
+
+                    if ( id > releaseNoteAttachmentID ) { releaseNoteAttachmentID = id; }
+                }
+            }
+
+        }
+
+        return releaseNoteAttachmentID;
+    }
+    
+    ////////////////////////////////////////////////////////
+    //
+    // EXCEPTION PROCESSING MINIONS
+    //
+    ////////////////////////////////////////////////////////
+
+    /**
+     * <p>
+     * Special processing for special exceptions.
+     * </p>
+     */
+    private  void    processThrowable( Throwable t )
+    {
+        if ( t instanceof java.net.UnknownHostException )
+        {
+            println( "Unknown host '" + t.getMessage() + "'. Can you ping this host from a shell window?" );
+        }
+    }
+
+    ////////////////////////////////////////////////////////
+    //
+    // MISC MINIONS
+    //
+    ////////////////////////////////////////////////////////
+
+    private  void    println( String text )
+    {
+        if ( _invokedByAnt )
+        {
+            log( text, Project.MSG_WARN );
+        }
+        else
+        {
+            System.out.println( text );
+        }
+    }
+    
+}

Propchange: db/derby/code/trunk/java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/code/trunk/releaseSummary.xml
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/releaseSummary.xml?view=auto&rev=538929
==============================================================================
--- db/derby/code/trunk/releaseSummary.xml (added)
+++ db/derby/code/trunk/releaseSummary.xml Thu May 17 07:05:18 2007
@@ -0,0 +1,116 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+
+<!-- 
+This is the template for the release summary which the Release Manager
+writes. The ReleaseNotesGenerator uses this summary in order to
+generate various sections of the release notes. Please replace all ???
+with real information.
+-->
+
+<summary>
+
+<!--
+    Release identifier.
+
+    E.g.: 10.3.0.3
+-->
+<releaseID>10.3.0.0</releaseID>
+
+<!--
+    Identifier of previous release. The release notes describe the
+    delta between releaseID and previousReleaseID.
+
+    E.g.: 10.2.1.7
+
+-->
+<previousReleaseID>10.2.2.0</previousReleaseID>
+
+<buildInfo>
+
+  <!-- Name of the branch. E.g.: 10.3 -->
+  <branch>10.3</branch>
+
+  <!-- Machine environment. E.g.:  Cygwin on Microsoft Windows XP Professional Version 2002 Service Pack 2. -->
+  <machine>Cygwin on Microsoft Windows XP Professional Version 2002 Service Pack 2.</machine>
+
+  <!-- Ant version. E.g.:  Apache Ant version 1.6.5 compiled on June 2 2005. -->
+  <antVersion>Apache Ant version 1.6.5 compiled on June 2 2005.</antVersion>
+
+  <!-- Output of "java -version" run from your jdk1.4 installation. E.g.:  Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_12-b03). -->
+  <jdk1.4>Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_12-b03).</jdk1.4>
+
+  <!-- Output of "java -version" run from your Java 6 installation. E.g.:  Java(TM) 2 Runtime Environment, Standard Edition (build 1.6.0-b105). -->
+  <java6> Java(TM) 2 Runtime Environment, Standard Edition (build 1.6.0-b105).</java6>
+
+  <!--
+         Say here whether you used osgi.jar to build org.apache.derby.osgi.EmbeddedActivator.
+         E.g.:  The osgi.jar was used to build org.apache.derby.osgi.EmbeddedActivator.
+  -->
+  <osgi>The osgi.jar was used to build org.apache.derby.osgi.EmbeddedActivator.</osgi>
+
+  <!--
+         Say which compilers you used.
+         E.g.:
+
+           The 1.4.2_12-b03 javac was used to compile all classes
+           except for the JDBC4 drivers. The JDBC4 driver classes were compiled using the 1.6.0-b105 javac.
+  -->
+  <compilers>The 1.4.2_12-b03 javac was used to compile all classes
+           except for the JDBC4 drivers. The JDBC4 driver classes were compiled using the 1.6.0-b105 javac.</compilers>
+
+  <!--
+         Say here whether you built the J2ME support and, if so, which
+         tookit you used.
+         E.g.: J2ME support was built using java.sun.com/j2me (j2me_cdc_fp-1_0_2).
+  -->
+  <jsr169>J2ME support was built using java.sun.com/j2me (j2me_cdc_fp-1_0_2).</jsr169>
+
+</buildInfo>
+
+<overview>
+
+<p>
+Derby is a pure Java relational database engine using standard SQL and
+JDBC as its APIs.
+</p>
+
+<p>
+Derby functionality includes:
+</p>
+
+<ul>
+<li>Embedded engine with JDBC drivers</li>
+<li>Network Server</li>
+<li>Network client JDBC drivers</li>
+<li>Command line tools: ij (SQL scripting), dblook (schema dump) and sysinfo (system info)</li>
+</ul>
+
+</overview>
+
+<newFeatures>
+
+<p>
+This is a bug-fix release. No new features were added.
+</p>
+
+</newFeatures>
+
+</summary>
+

Propchange: db/derby/code/trunk/releaseSummary.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: db/derby/code/trunk/tools/release/build.xml
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/tools/release/build.xml?view=diff&rev=538929&r1=538928&r2=538929
==============================================================================
--- db/derby/code/trunk/tools/release/build.xml (original)
+++ db/derby/code/trunk/tools/release/build.xml Thu May 17 07:05:18 2007
@@ -45,6 +45,20 @@
 
   <property name="src.excludes" value="tools/**/db2jcc*,tools/**/osgi.jar,tools/**/junit.jar,tools/**/jdbc2_0*,tools/java/jce*,tools/**/packaging.properties,java/demo/toursdb/toursdb/**,java/demo/toursdb/toursdb.out,java/demo/toursdb/toursdb.jar,tools/testing/derby/**,**/derby.log"/>
 
+<!-- These properties are used by the Release Notes Generator. -->
+
+  <property name="relnotes.src.summary" value="${basedir}/releaseSummary.xml" />
+  <property name="relnotes.src.buglist" value="${relnotes.src.reports}/fixedBugsList.xml" />
+  <property name="relnotes.src.notes" value="${relnotes.src.reports}/releaseNotesList.xml" />
+  <property name="relnotes.out.pamphlet" value="${basedir}/RELEASE-NOTES.html" />
+
+<!-- Define the task which generates the release notes -->
+  <taskdef
+    name="generateReleaseNotes"
+    classname="org.apache.derbyBuild.ReleaseNotesGenerator"
+    classpath="${out.dir}"
+  />
+
 <!-- Targets -->
 
   <target name="release" depends="clean,bin,lib,lib-debug,src"/>
@@ -72,6 +86,27 @@
              includes="CHANGES,COPYRIGHT,LICENSE,KEYS,NOTICE,RELEASE-NOTES.html,frameworks.DEPRECATED.txt"/>
     <fixcrlf srcdir="${basedir}" destdir="${lf.dir}" eol="lf"
              includes="CHANGES,COPYRIGHT,LICENSE,KEYS,NOTICE,RELEASE-NOTES.html,frameworks.DEPRECATED.txt"/>
+
+  </target>
+
+<!--
+   Generate the Release Notes
+
+   The ${relnotes.src.reports} property must point at a
+   directory containing the two JIRA reports:
+
+     fixedBugsList.xml  - This is a JIRA xml report of issues fixed in the release.
+
+     releaseNotesList.xml - This is a JIRA xml report of issues having detailed release notes.
+-->
+  <target name="genrelnotes">
+
+     <generateReleaseNotes
+       summaryFileName="${relnotes.src.summary}"
+       bugListFileName="${relnotes.src.buglist}"
+       releaseNotesListFileName="${relnotes.src.notes}"
+       pamphletFileName="${relnotes.out.pamphlet}"
+     />
 
   </target>
 

Added: db/derby/code/trunk/tools/release/templates/releaseSummaryTemplate.xml
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/tools/release/templates/releaseSummaryTemplate.xml?view=auto&rev=538929
==============================================================================
--- db/derby/code/trunk/tools/release/templates/releaseSummaryTemplate.xml (added)
+++ db/derby/code/trunk/tools/release/templates/releaseSummaryTemplate.xml Thu May 17 07:05:18 2007
@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+
+<!-- 
+This is the template for the release summary which the Release Manager
+writes. The ReleaseNotesGenerator uses this summary in order to
+generate various sections of the release notes. Please replace all ???
+with real information.
+-->
+
+<summary>
+
+<!--
+    Release identifier.
+
+    E.g.: 10.3.0.3
+-->
+<releaseID>???</releaseID>
+
+<!--
+    Identifier of previous release. The release notes describe the
+    delta between releaseID and previousReleaseID.
+
+    E.g.: 10.2.1.7
+
+-->
+<previousReleaseID>???</previousReleaseID>
+
+<!--
+    Information on the system used to build the release.
+-->
+
+<buildInfo>
+
+  <!-- Name of the branch. E.g.: 10.3 -->
+  <branch>???</branch>
+
+  <!-- Machine environment. E.g.:  Cygwin on Microsoft Windows XP Professional Version 2002 Service Pack 2. -->
+  <machine>???</machine>
+
+  <!-- Ant version. E.g.:  Apache Ant version 1.6.5 compiled on June 2 2005. -->
+  <antVersion>???</antVersion>
+
+  <!-- Output of "java -version" run from your jdk1.4 installation. E.g.:  Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_12-b03). -->
+  <jdk1.4>???</jdk1.4>
+
+  <!-- Output of "java -version" run from your Java 6 installation. E.g.: Java(TM) 2 Runtime Environment, Standard Edition (build 1.6.0-b105). -->
+  <java6>???</java6>
+
+  <!--
+         Say here whether you used osgi.jar to build org.apache.derby.osgi.EmbeddedActivator.
+         E.g.:  The osgi.jar was used to build org.apache.derby.osgi.EmbeddedActivator.
+  -->
+  <osgi>???</osgi>
+
+  <!--
+         Say which compilers you used.
+         E.g.:
+
+           The 1.4.2_12-b03 javac was used to compile all classes
+           except for the JDBC4 drivers. The JDBC4 driver classes were compiled using the 1.6.0-b105 javac.
+  -->
+  <compilers>???</compilers>
+
+  <!--
+         Say here whether you built the J2ME support and, if so, which
+         tookit you used.
+         E.g.: J2ME support was built using java.sun.com/j2me (j2me_cdc_fp-1_0_2).
+  -->
+  <jsr169>???</jsr169>
+
+</buildInfo>
+
+<!--
+    Here include a freeform section, describing the release. E.g.:
+
+<p>
+Derby is a pure Java relational database engine using standard SQL and
+JDBC as its APIs.
+</p>
+
+<p>
+Derby functionality includes:
+</p>
+
+<ul>
+<li>Embedded engine with JDBC drivers</li>
+<li>Network Server</li>
+<li>Network client JDBC drivers</li>
+<li>Command line tools: ij (SQL scripting), dblook (schema dump) and sysinfo (system info)</li>
+</ul>
+
+-->
+
+<overview>
+???
+</overview>
+
+<!--
+    Here describe the new features of this release. E.g.:
+
+<p>
+This is a bug-fix release. No new features were added.
+</p>
+
+-->
+
+<newFeatures>
+???
+</newFeatures>
+
+</summary>
+

Propchange: db/derby/code/trunk/tools/release/templates/releaseSummaryTemplate.xml
------------------------------------------------------------------------------
    svn:eol-style = native