[
https://issues.apache.org/jira/browse/DERBY-2570?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Rick Hillegas updated DERBY-2570:
---------------------------------
Attachment: derby-2570-v01.diff
Attaching derby-2570-v01.diff. This is a first version of the pamphlet
generator. Please take it for a test-drive.
A releaseSummary.xml
This is the release overview, which the Release Manager fills in. It is checked
into the codeline so that other members of the community can help the Release
Manager wordsmith the overview and description of new features.
A tools/release/templates/releaseSummaryTemplate.xml
This is a template file for creating releaseSummary.xml. The template has "???"
placeholders which the Release Manager should replace with real information.
M tools/release/build.xml
This contains a new "genrelnotes" target for generating the pamphlet. This
target assumes that you have defined the "relnotes.src.reports" variable in
your ant.properties. This variable points at a directory which contains the
following xml JIRA reports:
- fixedBugsList.xml - This is the xml JIRA report of issues addressed by the
release.
- releaseNotesList.xml - This is the xml JIRA report of issues which have
detailed release notes attached to them.
The "genrelnotes" target reads the above files, together with
trunk/releaseSummary.xml and generates the pamphlet as trunk/RELEASE-NOTES.html.
A java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java
This is the ant task which generates the release notes from various inputs. You
can run this as a standalone program, specifying the following arguments:
- The name of the summary file describing the release (modelled on
releaseSummary.xml).
- The name of the xml JIRA report of issues fixed in this release.
- The name of the xml JIRA report of issues which have detailed release notes
attached to them.
- The name of the html file which will hold the generated pamphlet.
M RELEASE-NOTES.html
This is the pamphlet generated by running the tool. This shows you what the
output looks like.
--------------------------------------------------------
To run the tool, define "relnotes.src.reports" in your ant.properties and
create the xml JIRA reports as described above in the comment on build.xml. Run
the top level build script in order to build ReleaseNotesGenerator. Then cd to
trunk/tools/release and type "ant genrelnotes".
The pamphlet generator attempts to connect to JIRA in order to grab the
detailed release notes attached to significant issues. Before running the tool,
it is worthwhile to try pinging issues.apache.org. If you can't ping
issues.apache.org from a shell window, then the tool will exit. You may need to
adjust your proxy and firewall settings.
It would be nice if you didn't have to hand-generate the xml JIRA reports.
Maybe the community could agree on some canonical JIRA filters which define
these reports. Then the ReleaseNotesGenerator could prod JIRA to produce the
reports.
> 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
> Assigned To: Rick Hillegas
> Attachments: derby-2570-v01.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.
