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 19:15:15 GMT

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

Rick Hillegas commented on DERBY-2570:

Hi, Myrna. Some more comments follow:

B: I think that, by default, Jira does ORs on field values. It's NOTs and ANDs that I don't
understand. It looks to me as though your filters need ORs and NOTs.

It's possible that the only NOT you need is this: "NOT fixed in the previous release."  I
think you can do that post-Jira filtering in ReleaseNotesGenerator, relying only on the <releaseID>
and <previousReleaseID> values from releaseSummary.xml. Or, at least, you could get
pretty close and then just scrub the Jira entries a little. Here's how it looks to me:

i) We assume that two releases are cut off the same branch if their release ids have the same
major and minor numbers.

ii) Once a bug has been marked as fixed in a given branch, it is assumed that it is fixed
in all subsequent releases in that branch.

iii) If <releaseID> and <previousReleaseID> are in the same branch, then we don't
need to perform the post-Jira filtering. The fact that a bug is marked as fixed in <releaseID>
means (because of ii) that the bug was not also fixed in <previousReleaseID>.

iv) If, however, <releaseID> and <previousReleaseID> are in different branches,
then we need to filter out all bugs which are marked as fixed in the <previousReleaseID>
branch. That is, all bugs marked as fixed in a release whose major and minor ids agree with
the major and minor ids of <previousReleaseID>.

I think that will work.

> 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