db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Daniel John Debrunner (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2570) Create a utility which generates Release Notes
Date Mon, 23 Apr 2007 20:54:15 GMT

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

Daniel John Debrunner commented on DERBY-2570:

On the template:

Looking at how these headings were used in the 10.2 release notes I think there needs to be
some clarification of what they actually mean.
This would lead to consistency in the release notes, maybe the template could include the

For example looking at the release notes for 10.2

For DERBY-1384
 "Problem - Maximum BLOB/CLOB length has increased to 2G-1"

That's not a problem, I think the problem is really "Application may allow BLOB/CLOB values
previously rejected".

"Symptoms" sometimes describes to old behaviour (e.g. DERBY-1295), I would think it would
describe symptoms the application will see when using the new software. 

"Cause" seems a confused section, I'm not really sure what its intention is. DERBY-822 seems
to have a clear cause of the issue, but then it overlaps with information given in the preceeding
symptoms section. Sometimes it seems to just describe old behaviour which I'm not sure is
relevant here.

"Solution" is sometimes used to describe the change made in Derby (e.g. DERBY-1652) and sometimes
the solution the application needs to make (e.g. DERBY-1867).

"Workaround" and "Solution" sometimes overlap

> 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
>         Attachments: releaseNote.html
> 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