[jira] [Updated] (HADOOP-7723) Automatically generate good Release Notes
[ https://issues.apache.org/jira/browse/HADOOP-7723?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Mit Desai updated HADOOP-7723: -- Target Version/s: 1.3.0 (was: 0.23.0, 1.3.0) > Automatically generate good Release Notes > - > > Key: HADOOP-7723 > URL: https://issues.apache.org/jira/browse/HADOOP-7723 > Project: Hadoop Common > Issue Type: Improvement >Affects Versions: 0.20.204.0, 0.23.0 >Reporter: Matt Foley >Assignee: Matt Foley > > In branch-0.20-security, there is a tool src/docs/relnotes.py, that > automatically generates Release Notes. Fix deficiencies and port it up to > trunk. -- This message was sent by Atlassian JIRA (v6.2#6252)
[jira] [Updated] (HADOOP-7723) Automatically generate good Release Notes
[ https://issues.apache.org/jira/browse/HADOOP-7723?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Matt Foley updated HADOOP-7723: --- Target Version/s: 0.23.0, 1.3.0 (was: 1.2.0, 0.23.0) > Automatically generate good Release Notes > - > > Key: HADOOP-7723 > URL: https://issues.apache.org/jira/browse/HADOOP-7723 > Project: Hadoop Common > Issue Type: Improvement >Affects Versions: 0.20.204.0, 0.23.0 >Reporter: Matt Foley >Assignee: Matt Foley > > In branch-0.20-security, there is a tool src/docs/relnotes.py, that > automatically generates Release Notes. Fix deficiencies and port it up to > trunk. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (HADOOP-7723) Automatically generate good Release Notes
[ https://issues.apache.org/jira/browse/HADOOP-7723?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Matt Foley updated HADOOP-7723: --- Target Version/s: 0.23.0, 1.2.0 (was: 1.1.1, 0.23.0) > Automatically generate good Release Notes > - > > Key: HADOOP-7723 > URL: https://issues.apache.org/jira/browse/HADOOP-7723 > Project: Hadoop Common > Issue Type: Improvement >Affects Versions: 0.20.204.0, 0.23.0 >Reporter: Matt Foley >Assignee: Matt Foley > > In branch-0.20-security, there is a tool src/docs/relnotes.py, that > automatically generates Release Notes. Fix deficiencies and port it up to > trunk. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (HADOOP-7723) Automatically generate good Release Notes
[ https://issues.apache.org/jira/browse/HADOOP-7723?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Matt Foley updated HADOOP-7723: --- Target Version/s: 0.23.0, 1.1.1 (was: 1.1.0, 0.23.0) > Automatically generate good Release Notes > - > > Key: HADOOP-7723 > URL: https://issues.apache.org/jira/browse/HADOOP-7723 > Project: Hadoop Common > Issue Type: Improvement >Affects Versions: 0.20.204.0, 0.23.0 >Reporter: Matt Foley >Assignee: Matt Foley > > In branch-0.20-security, there is a tool src/docs/relnotes.py, that > automatically generates Release Notes. Fix deficiencies and port it up to > trunk. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (HADOOP-7723) Automatically generate good Release Notes
[ https://issues.apache.org/jira/browse/HADOOP-7723?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Matt Foley updated HADOOP-7723: --- Target Version/s: 0.20.206.0, 0.23.0 (was: 0.23.0, 0.20.205.0) > Automatically generate good Release Notes > - > > Key: HADOOP-7723 > URL: https://issues.apache.org/jira/browse/HADOOP-7723 > Project: Hadoop Common > Issue Type: Improvement >Affects Versions: 0.20.204.0, 0.23.0 >Reporter: Matt Foley >Assignee: Matt Foley > > In branch-0.20-security, there is a tool src/docs/relnotes.py, that > automatically generates Release Notes. Fix deficiencies and port it up to > trunk. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (HADOOP-7723) Automatically generate good Release Notes
[
https://issues.apache.org/jira/browse/HADOOP-7723?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Matt Foley updated HADOOP-7723:
---
Description: In branch-0.20-security, there is a tool
src/docs/relnotes.py, that automatically generates Release Notes. Fix
deficiencies and port it up to trunk. (was: The current tool for generating
release notes, relnotes-gen.py, describes all the Jiras fixed in the release.
Jiras with non-empty "Release Note" field show the release note, others show
the Description field. They are sorted in reverse-numerical order. I propose
the following changes:
# List the jiras with Release Notes first. These are usually the larger or
incompatible changes that most readers will care about most. Then list the
other jiras with their descriptions.
# Sort in forward numerical order.
# Limit description lengths to 500 characters, but print the full Release Notes
for any jira that has them.
# Generate lists of jiras by combining info from the Jira database (Fixed jiras
with Fixed Version of X.Y.Z release) and the CHANGES.txt file (additions since
the last release). This will accomodate jiras that have been fixed in the
current new release, but can't be marked Resolved due to being pending on other
branch(es).)
Target Version/s: 0.20.205.0, 0.23.0 (was: 0.23.0, 0.20.205.0)
Summary: Automatically generate good Release Notes (was: Modify
relnotes-gen.py to list "Release Notes" separately from "Other Issues Fixed",
and other improvements)
Many of our peer projects generate trivial "release notes" as a list of bugs
fixed, giving the bug number and one-line description, for instance as
auto-generated by Jira under:
bq. Project > Road Map (or Change Log) > Release Notes
e.g., for 0.20.205.0:
bq.
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310942&version=12316392
However, the Hadoop project has tried to do better than this, by actually
collecting "Release Note" field values from fixed bugs (or Description fields
from bugs with empty Release Note fields), and presenting them in the form of
the releasenotes.html document template, e.g., for 0.20.205.0:
bq. http://hadoop.apache.org/common/docs/r0.20.205.0/releasenotes.html
When doing the notes for 0.20.205.0, I found that the tool for doing these
collected Release Notes (src/docs/relnotes.py) was broken in a couple of
respects:
* It was inconsistent with the documented process in HowToRelease, because it
wanted bug lists piped in somewhat differently.
* It assumed that Jira's report on "Resolved" bugs was sufficient, while that
list often differs somewhat from CHANGES.txt. In particular, bugs held open
for ports to other branches would not be reported as Resolved in the current
branch.
* Most critically, the feature to extract the "Release Note" field from jira
issues doesn't work unless the person running it has top-level Jira admin privs
(not just admin privs for the Hadoop projects). This restriction is built in
to the Jira CLI tool ('jira.sh').
I fixed these issues, and will submit the improved tool for review. It now
does the following:
* Query Jira for bugs resolved in the current release.
* Query CHANGES.txt for bugs resolved in the current release.
* Merge and diff the two lists, reporting the result and giving the Release
Manager an opportunity to resolve the variances.
* Look up the Release Note field for each resolved bug, scraping it from a
'curl' call rather than the admin-restricted Jira CLI tool.
* If there is no Release Note, use the Description field but limit it to the
first 500 characters, in case the Description is long.
* Format as before.
I also suggest these enhancements:
* List the jiras with Release Notes first. These are usually the larger or
incompatible changes that most readers will care about most. Then list the
other jiras with their descriptions.
* Sort in forward numerical order, instead of reverse.
> Automatically generate good Release Notes
> -
>
> Key: HADOOP-7723
> URL: https://issues.apache.org/jira/browse/HADOOP-7723
> Project: Hadoop Common
> Issue Type: Improvement
>Affects Versions: 0.20.204.0, 0.23.0
>Reporter: Matt Foley
>Assignee: Matt Foley
>
> In branch-0.20-security, there is a tool src/docs/relnotes.py, that
> automatically generates Release Notes. Fix deficiencies and port it up to
> trunk.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
