[
https://issues.apache.org/jira/browse/DERBY-2570?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12491353
]
Rick Hillegas commented on DERBY-2570:
--------------------------------------
> 1) By editting a JIRA's one line summary, you affect the JIRA's summary as it
> appears in the pamphlet.
I want to make sure that we're not talking past one another here. What the
above comment refers to are the 1-line summaries which appear in
RELEASE_NOTES.html in the section titled "Bug Fixes".
The particular example you cite (DERBY-1384) is not a 1-line summary. Instead,
it appears in 10.2's RELEASE_NOTES.html in the Issues section, with its own
expanded ItemNote. Fine-tuning this ItemNote would be covered by:
> 2) By editting a JIRA's releaseNote.html, you affect what goes into the
> section on "Behavior Changes from Previous Releases".
For these issues, I'm thinking that we wouldn't include the 1-line summary from
the JIRA. Instead, the summary would be what appears in the ItemNote's "Summary
of Change" section.
Are you saying that we should not attach separate releaseNote.html files to
affected JIRAs and should, instead, collect all the ItemNotes in a master file
for the release? I can see some appeal in this--it certainly would simplify the
process of generating the pamphlet. However, it would make it harder to track
whether an ItemNote has actually been written for a JIRA which has been marked
"Release Note Needed".
> 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
> Attachments: releaseNote.html, 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.
