db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Myrna van Lunteren (JIRA)" <j...@apache.org>
Subject [jira] Updated: (DERBY-2570) Create a utility which generates Release Notes
Date Fri, 25 May 2007 23:17:16 GMT

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

Myrna van Lunteren updated DERBY-2570:

    Attachment: DERBY-2570_20070525.diff

Attaching a patch that
1. hacks through Rick's elegant code to massage the issues accepted into the release notes
bug fixing area to be only those that:
    - do not have fixversion listing the previous release
    - do not have fixversion listing (this one is hardcoded)
    - only are of type bug, improvement, new feature, or sub-task
    - do not have component 'Test'.
I already checked in a revision of the RELEASE-NOTES.html built using this...
But I did not want to check in my modifications without a review.

2. add a class, JiraConnector, that goes after JIRA's xml and pulls a report based on hardwired
   This query can be modified, or the file can be made to take a parameter...I tried the parameter
approach and for some reason the resulting xml was quite different. So, I resorted to leaving
this in hard-coded. Right now, also, the file name that the JiraConnector creates is not what
is expected by the ReleaseNotesGenerator class. That too, can be modified later.

This patch is ready for review.

> Create a utility which generates Release Notes
> ----------------------------------------------
>                 Key: DERBY-2570
>                 URL: https://issues.apache.org/jira/browse/DERBY-2570
>             Project: Derby
>          Issue Type: Improvement
>          Components: Build tools
>    Affects Versions:
>            Reporter: Rick Hillegas
>         Assigned To: Rick Hillegas
>         Attachments: derby-2570-v01.diff, DERBY-2570_20070525.diff, releaseNote.html,
releaseNote.html, releaseSummaryTemplate.xml
> This proposal summarizes an off-list conversation among Myrna van Lunteren, Bernt Johnsen,
Andrew McIntyre, and myself.
> Currently, there is a template for release notes in the top level directory of the code
tree. Actually filling in this template is a time-consuming, error-prone process. We would
like to automate this process as much as possible. We believe it ought to be possible to generate
the Release Notes given the following inputs:
> 1) A high-level description of the release. The Release Manager would write this description,
based on a template.
> 2) An xml report produced by a JIRA filter. The filter would list all of the JIRAs addressed
by the release.
> In order for this to work, we would need for the community to agree on conventions for
the release notes which are attached to JIRAs, viz.,  the JIRAs whose "Release Note Needed"
toggles are turned on. These JIRA-specific notes become items in the Issues section of the
final Release Notes. Each of these items calls the reader's attention to a significant topic
involving Derby's behavior, that behavior's compatibility with previous releases, and adjustments
which the user may need to make to her applications.
> The following approach makes sense to us:
> A) The community will agree on an html template for these notes.
> B) The note-writer will fill in this template and attach it to the JIRA using a canonical
file name, say "releaseNote.html".
> C) Various iterations of the note may be needed.
> D) The utility for generating Release Notes will grab the latest rev of "releaseNote.html"
attached to the JIRA.
> This effort involves at least two major steps:
> I) Getting the community to agree to these note-writing conventions.
> II) Writing the Release Note generator.

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

View raw message