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 Mon, 23 Apr 2007 15:32:15 GMT

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

Rick Hillegas commented on DERBY-2570:
--------------------------------------

> An Apache open *source* release is a snapshot of the source at a specific revision, thus
all artifacts of the release need to be in svn.

The release notes already appear under svn in the distribution zips and tars as well as on
the release download page. This was true before RELEASE_NOTES.html was added to the code tree
in 10.2. We would simply be going back to the 10.1 state of affairs. Were we violating Apache
process back then?

I think the issue may be: Are the release notes source or are they a build artifact? I'm viewing
them as a build artifact. The sources for this aftifact are:

o The state of JIRA at some point in time.

o A summary written by the release manager.

Perhaps the summary could be placed under source control?

> 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: 10.3.0.0
>            Reporter: Rick Hillegas
>
> 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.


Mime
View raw message