db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Rick Hillegas (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2570) Create a utility which generates Release Notes
Date Tue, 29 May 2007 13:58:15 GMT

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

Rick Hillegas commented on DERBY-2570:

Thanks for the patch, Myrna. I have a couple comments.

It seems to me that this patch does 2 very useful things:

1) It automatically generates one of the JIRA reports--that's what I think JiraConnector does.

2) It filters that JIRA report, throwing away unwanted issues.

A) It seems to me that JiraConnector could be folded into ReleaseNotesGenerator. That is,
ReleaseNotesGenerator could just run this query itself and grab the resulting xml document
off the web using the same machinery that is used to grab the individual release notes (see
ReleaseNotesGenerator.getReleaseNote()). For the moment, the query could be hard-coded and
later on we could sand down the parameter-substitution problem you saw. If you folded JiraConnector
into ReleaseNotesGenerator, then we could get rid of one of the arguments to ReleaseNotesGenerator
and eliminate yet another step in our build process.

B) It seems to me that some of the filtering you are doing (e.g., looking for types bug, improvement,
new feature, and subtask) could be folded into the Jira query and removed from the special
checks in ReleseNotesGenerator. Maybe the exclusion of Test components has to be a post-Jira
filter, but I wonder if that one could be folded into the query too. I'm puzzled why there's
a special check for this mean that those issues need to be adjusted so that
they list as one of their fixversions? In general, it would be nice to have a clear
model of what filters are done in Jira and what 
filters are done post-Jira.

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