[Python-Dev] Split Misc/NEWS into individual files

[Wes Turner]

tools, projects, changelog filenames

x-posting from
https://github.com/python/core-workflow/issues/6#issuecomment-282529194 :

...

changelog filenames

- CHANGELOG.rst
- HISTORY.rst
- whatsnew.rst
- Misc/NEWS

### ``Escaping M``arkup
NOTE: commit logs may contain (executable) markup
  - **https://wiki.python.org/moin/EscapingHtml**
  -
https://github.com/westurner/dotfiles/blob/develop/scripts/git-changelog.py
    - ``rst_escape()`` (!?)

Tools

- mergenews
  - Src: https://bitbucket.org/larry/mergenews
  - splitnews
  - mergenews
  - pyci
    - hg-specific
- Reno
  - Src: https://github.com/openstack/reno
  - Src: https://github.com/openstack/reno/blob/master/reno/formatter.py
  - Src: https://github.com/openstack/reno/blob/master/reno/sphinxext.py
  - PyPI: https://pypi.org/project/reno
  - Docs:
https://docs.openstack.org/developer/reno/usage.html#editing-a-release-note
  - [x] ENH: "make sections configurable"
https://github.com/openstack/reno/commit/081a4145e18c82acba877ee22c180b3428c773f6

- Towncrier
  - Src: https://github.com/hawkowl/towncrier
  - PyPI: https://pypi.org/project/towncrier

Projects:

- CPython
  - https://github.com/python/cpython/blob/master/Misc/NEWS
- IPython
  -
https://github.com/ipython/ipython/tree/master/docs/source/whatsnew/pr#documenting-whats-new
  - https://github.com/ipython/ipython/tree/master/docs/source/whatsnew
  - Src:
https://github.com/ipython/ipython/blob/master/tools/update_whatsnew.py
- Matplotlib
  -
https://github.com/matplotlib/matplotlib/blob/master/doc/users/whats_new.rst
  -
https://github.com/matplotlib/matplotlib/tree/master/doc/users/prev_whats_new
  - https://github.com/matplotlib/matplotlib/tree/master/doc/users/whats_new
README.rst
- scikit-learn
  - ENH, BUG, DOC, MRG
  -
https://github.com/scikit-learn/scikit-learn/blob/master/doc/whats_new.rst
- statsmodels
  - ENH, BUG, DOC, MRG
  -
https://github.com/statsmodels/statsmodels/tree/master/docs/source/release
- OpenStack Nova
  - reno
  - https://git.openstack.org/cgit/openstack/nova/tree/releasenotes/notes
  - https://github.com/openstack/nova/tree/master/releasenotes/notes
  -
http://lists.openstack.org/pipermail/release-announce/2017-February/000784.html


On Sat, Feb 25, 2017 at 1:10 PM, Brett Cannon <brett at python.org> wrote:

>
>
> On Wed, 22 Feb 2017 at 13:30 Ned Deily <nad at python.org> wrote:
>
>> On Feb 22, 2017, at 07:27, Victor Stinner <victor.stinner at gmail.com>
>> wrote:
>>
>> > [...]My idea is not new, it's already discussed in the Python
>> core-workflow:
>> > https://github.com/python/core-workflow/issues/6
>> >
>> > I'm opening a thread on python-dev because Misc/NEWS quickly became a
>> > blocker issue with the Python new workflow.
>> >
>> > What do you think of the overall idea?
>>
>> I think we clearly need to do something about Misc/NEWS but this issue is
>> already under discussion in the core-workflow working group and I think we
>> shouldn't be moving it to python-dev until there is a final concrete
>> proposal.  I know it is high on Brett's list but I believe he's taking a
>> few days of holiday right so he may not be able to respond immediately.
>> Let's move this discussion over to the core-workflow mailing list.  It can
>> wait a few days.
>>
>> https://mail.python.org/mailman/listinfo/core-workflow
>
>
> Ned is right that I was on holiday for the past week and am slowly digging
> myself out from underneath my pile of email.
>
> Ned is also right that I view the Misc/NEWS issue the most important thing
> to solve next for our workflow as we have been putting up with merge
> conflicts on this file for long enough.
>
> Since this is going to be a somewhat protracted discussion as there are
> multiple tools consider (including writing our own), I think we should keep
> the discussion at https://github.com/python/core-workflow/issues/6.
>
> _______________________________________________
> Python-Dev mailing list
> Python-Dev at python.org
> https://mail.python.org/mailman/listinfo/python-dev
> Unsubscribe: https://mail.python.org/mailman/options/python-dev/
> wes.turner%40gmail.com
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-dev/attachments/20170225/a3f5b536/attachment.html>