[core-workflow] the Misc/NEWS problem

[Doug Hellmann]

[I replied just to Brett, not the list.]

> On Mar 6, 2016, at 11:02 AM, Doug Hellmann <doug at doughellmann.com> wrote:
> 
> Excerpts from bcannon's message of 2015-09-07 01:03:18 +0000:
>> I forgot to follow up here that there was nary a peep from
>> python-committers about the proposal of keeping NEWS entries in the issue
>> tracker, so we have a green light to implement this idea.
> 
> Sorry for following up on this so late; I'm just catching up on the
> archives and project status.
> 
> You might be interested in a tool called "reno" that we built for
> managing OpenStack release notes. Contributors place YAML files
> containing release notes in the source tree, and reno uses the git
> branch and tag history to determine which version those notes belong
> to and to build the set of notes to be displayed. There's a command
> line app to dump a simple RST file and Sphinx integration module
> to make it easy to integrate the published release notes along with
> other documentation. Because notes are part of the git history, it's
> easy to include them with patches copied into multiple branches for
> backporting fixes. Because notes are in files, instead of commit
> messages, it is possible to change the note after the fact. And because
> they're in files they go with the source.
> 
> More info on reno (including design considerations) is available
> at http://docs.openstack.org/developer/reno/ and some published
> release notes for the Nova project are available at
> http://docs.openstack.org/releasenotes/nova/.
> 
> If you're interested, I'm happy to answer questions here, now that
> I'm subscribed to the list.
> 
> Doug
> 
>> 
>> On Mon, Aug 10, 2015, 15:39 Brett Cannon <bcannon at gmail.com> wrote:
>> 
>>> I have told python-committers of our plan to make sure it won't lead to a
>>> revolt.
>>> 
>>> On Sat, 8 Aug 2015 at 14:25 Brett Cannon <bcannon at gmail.com> wrote:
>>> 
>>>> On Sat, Aug 8, 2015 at 1:18 PM R. David Murray <rdmurray at bitdance.com>
>>>> wrote:
>>>> 
>>>>> On Sat, 08 Aug 2015 17:44:04 -0000, Brett Cannon <bcannon at gmail.com>
>>>>> wrote:
>>>>>> OK, assuming David's in agreement then I think this approach wins with
>>>>> the
>>>>>> comma-separated field for commits that the hg hook for Roundup
>>>>> auto-appends
>>>>>> to and of course the field to enter the NEWS entry.
>>>>>> 
>>>>>> Now the next question is how easy/hard is it to implement this, how
>>>>> long
>>>>>> will it take, and who is willing to do the work? With this in hand we
>>>>> can
>>>>>> propose it to python-committers for 3.6 since the NEWS file should be
>>>>> easy
>>>>>> enough to back-fill to this approach while its still small.
>>>>> 
>>>>> Yes I agree this is the best approach, assuming we can get it
>>>>> implemented.  The advantage of #4, though, is that Ezio already did the
>>>>> work.
>>>>> 
>>>>> I'm *willing* to do the roundup work, but I don't know as I have the
>>>>> required time, at least for the next month.  Part of the trick is the
>>>>> need to get a test instance set up...there was work done at PyCon and
>>>>> after at making a tracker-in-a-box, so I'd need to find out where that
>>>>> was at and learn how to use it (or finish it, if needed).  The code
>>>>> itself is probably a half-day job, probably including enhancing the hook
>>>>> to update the commits field.  But together with getting a working test
>>>>> instance we're talking a couple days work at least.
>>>>> 
>>>> 
>>>> Perk of getting the tracker-in-a-box working is it's a one-time cost that
>>>> will be beneficial long term.
>>>> 
>>>> I also don't think there is a rush since we still have to convince
>>>> python-committers that this is the right solution. I plan to propose it on
>>>> Monday to the list to make sure we have buy-in.
>>>> 
>>>> 
>>>>> Writing the NEWS generating script is a not exactly trivial job, but
>>>>> probably wants to wait until we have the REST API.  So we'd have
>>>>> upgrading our Roundup to that when it lands on the list as well, with a
>>>>> 3.6 Beta 1 deadline on getting it all done.
>>>>> 
>>>> 
>>>> Yeah, so we have a bit of time to worry about the generation script.
>>>> 
>>> 
>> -------------- next part --------------
>> An HTML attachment was scrubbed...
>> URL: <http://mail.python.org/pipermail/core-workflow/attachments/20150907/d59baee3/attachment-0001.html>