8000 Support GitHub Issues (#431) · python/core-workflow@6008a9b · GitHub
[go: up one dir, main page]

Skip to content

Commit 6008a9b

Browse files
Support GitHub Issues (#431)
* Support GitHub Issues Use `issue` instead of `bpo` in the metadata. Use `gh-<number>` in the misc/news filename Bump the version to 1.1.0 Closes #428 * Test against Python 3.10 * Clarify that b.p.o means bugs.python.org on the changelog Co-authored-by: Oleg Iarygin <dralife@yandex.ru> * Support bpo as well because the `blurb merge` command still need to be able to read the existing `bpo-` news files. If the metadata contains `bpo-`, then append `bpo-` to the filename. Else, append `gh-issue`. * Update readme to use `gh-issue` instead of `gh-` * Use `gh-issue` when both `bpo` and `gh-issue` exist. Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
1 parent 90f9ca1 commit 6008a9b

13 files changed

+127
-72
lines changed

blurb/README.rst

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Under ``Misc/NEWS.d`` you'll find the following:
4545
the various ``Misc/NEWS`` categories. Inside these subdirectories
4646
are more ``.rst`` files with long, uninteresting, computer-generated
4747
names. Example:
48-
``Misc/NEWS.d/next/Library/2017-05-04-12-24-06.bpo-25458.Yl4gI2.rst``
48+
``Misc/NEWS.d/next/Library/2017-05-04-12-24-06.gh-issue-25458.Yl4gI2.rst``
4949

5050

5151
blurb subcommands
@@ -85,9 +85,9 @@ in the correct place, and stages it in ``git`` for you.
8585
The template for the ``blurb add`` message looks like this::
8686

8787
#
88-
# Please enter the relevant bugs.python.org issue number here:
88+
# Please enter the relevant GitHub issue number here:
8989
#
90-
.. bpo:
90+
.. gh-issue:
9191

9292
#
9393
# Uncomment one of these "section:" lines to specify which section
@@ -106,13 +106,13 @@ The template for the ``blurb add`` message looks like this::
106106
#.. section: C API
107107

108108
# Write your Misc/NEWS entry below. It should be a simple ReST paragraph.
109-
# Don't start with "- Issue #<n>: " or "- bpo-<n>: "or that sort of stuff.
109+
# Don't start with "- Issue #<n>: " or "- gh-issue<n>: " or that sort of stuff.
110110
###########################################################################
111111

112112
Here's how you interact with the file:
113113

114-
* Add the ``bugs.python.org`` issue number for this checkin to the
115-
end of the ``.. bpo:`` line.
114+
* Add the GitHub issue number for this checkin to the
115+
end of the ``.. gh-issue:`` line.
116116

117117
* Uncomment the line with the relevant ``Misc/NEWS`` section for this entry.
118118
For example, if this should go in the ``Library`` section, uncomment
@@ -126,11 +126,11 @@ Here's how you interact with the file:
126126
When ``blurb add`` gets a valid entry, it writes it to a file
127127
with the following format::
128128

129-
Misc/NEWS.d/next/<section>/<datetime>.bpo-<bpo>.<nonce>.rst
129+
Misc/NEWS.d/next/<section>/<datetime>.gh-issue-<issue_number>.<nonce>.rst
130130

131131
For example, a file added by ``blurb add`` might look like this::
132132

133-
Misc/NEWS.d/next/Library/2017-05-04-12-24-06.bpo-25458.Yl4gI2.rst
133+
Misc/NEWS.d/next/Library/2017-05-04-12-24-06.gh-issue-25458.Yl4gI2.rst
134134

135135
``<section>`` is the section provided in the checkin message.
136136

@@ -172,7 +172,7 @@ for the "sections" inside each release, whereas ``blurb merge``
172172
has a hard-coded preferred ordering for the sections. Also,
173173
**blurb** aggressively reflows paragraphs to < 78 columns,
174174
wheras the original hand-edited file occasionally had lines
175-
> 80 columns. Finally, **blurb** strictly uses ``bpo-<n>:`` to
175+
> 80 columns. Finally, **blurb** strictly uses ``gh-issue-<n>:`` to
176176
specify issue numbers at the beginnings of entries, wheras
177177
the legacy approach to ``Misc/NEWS`` required using ``Issue #<n>:``.
178178

@@ -247,6 +247,12 @@ part of the cherry-picking process.
247247
Changelog
248248
---------
249249

250+
1.1.0
251+
~~~~~
252+
253+
- Support GitHub Issues in addition to b.p.o (bugs.python.org).
254+
If "gh-issue" is in the metadata, then the filename will contain "gh-issue-<number>" instead of "bpo-".
255+
250256
1.0.7
251257
~~~~~
252258

0 commit comments

Comments
 (0)
0