[ 
https://issues.apache.org/jira/browse/DERBY-4593?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Rick Hillegas updated DERBY-4593:
---------------------------------

    Attachment: derby-4593-01-ab-initialReleaseNotes.diff

Attaching derby-4593-01-ab-initialReleaseNotes.diff. This patch makes some 
changes to the ReleaseNotesGenerator in order to bring it up-to-date with the 
current shape of JIRA reports. This patch also checks in a first version of the 
10.6 release notes.

The ReleaseNotesGenerator was supposed to save the release manager time when 
preparing the release notes. I still think the tool saves time. However, it is 
clear that the ReleaseNotesGenerator needs to be tweaked for every release. 
That is because this tool scrapes its information from the xml versions of 
reports created from JIRA filters. The shape of those reports changes 
significantly during the interval between Derby releases. In the future, it may 
be worthwhile to change the tool to get its raw data from one of the 
programmatic interfaces to JIRA. Or it may not. After a cursory inspection of 
those apis, I wonder whether they will be any more stable.

In previous releases, the xml reports did not need much scrubbing. All you had 
to do was strip out the DOCTYPE declaration at the top of the report. I find 
that now that I need a DOCTYPE declaration of the non-breaking-space 
entity--otherwise the xml report will be unparsable. So, you need to replace 
the DOCTYPE declaration with this:

<!DOCTYPE xsl:stylesheet [<!ENTITY nbsp "&#160;">]>

More importantly, I found that this time around, I could not figure out how to 
create a JIRA report which was both in a valid xml format and contained a list 
of attachments. The xml format is important because the alternative format 
generated by JIRA, viz. html, is not legal, parsable markup. The attachment 
list is important because that is where we find the pointers to the actual 
detailed release notes.

I ran out of enthusiasm for modifying the ReleaseNotesGenerator. Instead of 
plugging in some new mechanism for divining the latest version of 
releaseNote.html for each issue, I hard-coded the attachment ids for the 
handful of 10.6 issues which need release notes.

Touches the following files:

-------

M      java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java

Removed a diagnostic message which I found distracting.

-------

M      java/build/org/apache/derbyBuild/JiraIssue.java

The issue id and title have moved into different elements since the last time 
we ran the tool. I changed JiraIssue to account for this movement. In addition, 
I hardcoded the attachment ids of the detailed release notes.

-------

M      releaseSummary.xml

Detailed description of the 10.6 release.

-------

M      RELEASE-NOTES.html

Generated output which accompanies the release distributions.


> Track tasks needed to release Derby 10.6.1
> ------------------------------------------
>
>                 Key: DERBY-4593
>                 URL: https://issues.apache.org/jira/browse/DERBY-4593
>             Project: Derby
>          Issue Type: Task
>    Affects Versions: 10.6.0.0
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>         Attachments: derby-4593-01-ab-initialReleaseNotes.diff
>
>
> This is an issue which tracks the work needed to produce the 10.6.1 release.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to