diff --git a/readme.rst b/readme.rst index b07ca62..ffe9741 100644 --- a/readme.rst +++ b/readme.rst @@ -22,6 +22,10 @@ A ``Misc/NEWS.d`` file `is needed `_ for almost all non-trivial changes to CPython. +For an entry in the ``Security`` section, blurb-it also offers an optional +CVE field. Give the identifier in the ``CVE-YYYY-NNNN`` form and blurb-it +records it as ``.. cve:`` metadata at the top of the news file. + To use blurb-it, you must be logged in to GitHub. Install blurb-it GitHub App to your account, and then grant the ``write`` access to your diff --git a/templates/add_blurb.html b/templates/add_blurb.html index ce5baf3..79ee8d4 100644 --- a/templates/add_blurb.html +++ b/templates/add_blurb.html @@ -57,12 +57,12 @@

📜🤖 Blurb it again?

-
+
- Optional. The CVE identifier (CVE-YYYY-NNNN) for a Security entry only. + Optional. The CVE identifier (CVE-YYYY-NNNN) for this security fix.
@@ -76,4 +76,25 @@

📜🤖 Blurb it again?

Alternatively, you can use blurb on the command line.
+ + {% endblock %} diff --git a/templates/howto.html b/templates/howto.html index 1da3622..73a0f3e 100644 --- a/templates/howto.html +++ b/templates/howto.html @@ -6,6 +6,7 @@

So far, the way you would add the news entry is by using blurb command line tool, that can be installed using PyPI.

But now, we’re going to defy the Zen of Python’s “there should be only one way to do it”, and present you with another way to do it: blurb-it. {{ app_protocol }}://{{ app_url }}/

blurb-it provides a web interface for you to create news entry to your own CPython pull request. That means, you can do this from your phone, as long as you have a webbrowser and connected to the internet.

+

Fill in the issue and pull request numbers, choose the section, and write the entry. When you choose the Security section, an optional CVE field appears. Give the identifier in the CVE-YYYY-NNNN form and blurb-it records it as .. cve: metadata at the top of the news file.

blurb-it is a GitHub App owned by The PSF. You’ll need to install it and give write permission to your own fork’s cpython repo (so it can create the news file). Since the app will have write access to the repo, you should not install this on any other repo.

Please give this a try and let me know of any issues by filing a bug in the blurb-it repo.

The use of blurb-it is optional. You can still add news file using the blurb command line tool.