Skip to content

Add "Misc/NEWS.d" directory tree for "blurb". #2316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 22, 2017
Merged

Add "Misc/NEWS.d" directory tree for "blurb". #2316

merged 2 commits into from
Jun 22, 2017

Conversation

larryhastings
Copy link
Contributor

CPython workflow is changing! We're going to start using "blurb"
to manage Misc/NEWS entries:
https://github.com/python/core-workflow
(This will be a big win for release managers, honest.)

This checkin simply populates the "Misc/NEWS.d" subdirectory tree
so that people can start putting their news entries in there.
No other changes (yet).

CPython workflow is changing!  We're going to start using "blurb"
to manage Misc/NEWS entries:
    https://github.com/python/core-workflow
(This will be a big win for release managers, honest.)

This checkin simply populates the "Misc/NEWS.d" subdirectory tree
so that people can start putting their news entries in there.
No other changes (yet).
@brettcannon
Copy link
Member

Should the files be .rst files so that we can eventually add a link back to blurb that renders appropriately when people look in the directory through the GitHub UI?

@brettcannon
Copy link
Member

And I think @Haypo once asked for a Security/ subdirectory.

@vstinner
Copy link
Member

Yes, I would like to group all security issues to ease the work of vendors like Linux distributions who backports fixes in older versions.

@larryhastings
Copy link
Contributor Author

Please make up your mind about "Security". Right now "Security" is a metadata tag applied to news entries in any category. There are about a half-dozen Misc/NEWS entries that have "[Security]" in the text; and I turn that into the "Security" tag. I don't do anything with the tag yet, but the metadata is there and I figured we could bikeshed how to present it later (e.g. prepend/append the word "security" to the text somewhere, with a link to... somewhere.) And yes this isn't documented yet.

As for making them .rst files--who would see that as rendered hypertext? Would GitHub automatically render it if you browse into that directory when viewing cpython source?

@brettcannon
Copy link
Member

brettcannon commented Jun 21, 2017

@larryhastings ah, then if that's already implemented then let's try that to start and we can change later if necessary.

As for who will see the rendered hypertext, when you visit in the future e.g. https://github.com/python/cpython/tree/master/Misc.d/Library then you would see the README rendered as the text below the file list (just like at https://github.com/python/cpython/tree/master/Misc you see the plain text README).

@vstinner
Copy link
Member

Please make up your mind about "Security". Right now "Security" is a metadata tag applied to news entries in any category.

I would like to stop using "[Security]" "tag" on NEWS entries, but instead put all security entries in a new section without this tag. Example:

Security
========

* bpo-123456: Fix super critical vulnerabilty

@larryhastings
Copy link
Contributor Author

@Haypo: What would you like me to do with the existing entries with the security tag? Remove it, and instead change those entries to be in the new "Security" category?

@brettcannon: Do you defer to Victor? (Victor: I'm gonna do what Brett tells me to.)

@vstinner
Copy link
Member

@Haypo: What would you like me to do with the existing entries with the security tag? Remove it, and instead change those entries to be in the new "Security" category?

If it's not too hard, please move existing entries to a new Security category.

Otherwise, it's also fine to leave existing entries unchanged: keep the [Security] prefix.

@larryhastings
Copy link
Contributor Author

It's not hard to move them to a new "Security" category. It's all a big hack anyway, what's one more!

If you like, I can tag you on the PRs when I actually break Misc/NEWS up into separate files, so you can check over the stuff that gets auto-tagged as Security.

I actually wouldn't mind if you recategorize existing news entries anyway. But, please, no hacking up Misc/NEWS for now--if you want to change the existing news entries, please wait until after my "blurb split" is checked in. My Misc/NEWS parser is mildly fragile, and incautious people keep adding novel (and invalid!) formatting and forcing me to hack up my parser to match.

@vstinner
Copy link
Member

vstinner commented Jun 22, 2017 via email

@larryhastings
Copy link
Contributor Author

It'll be an easy change to make once I convert Misc/NEWS into the blurb data format.

The plan is, once this PR is accepted (and one very similar PR for each of the other open branches), we'll wait a week to give the active PRs a chance to land, then I'll convert all the open branches over to blurb all at once. After that, i invite you to make all the changes you see fit.

@brettcannon
Copy link
Member

@larryhastings I hereby defer to @Haypo on how to categorize. 😄 So I guess add the directory now and then we can move stuff around in a separate PR later.

@larryhastings
Copy link
Contributor Author

I've added a directory for the "Security" category. For what it's worth, it's now the first category, in front of "Core and Builtins", as befitting its importance. I've also changed the README.txt files for README.rst files.

Copy link
Member

@brettcannon brettcannon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@larryhastings larryhastings merged commit ea00798 into python:master Jun 22, 2017
@larryhastings larryhastings deleted the populate-misc-news-d-master branch June 23, 2017 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants