Ensure gh-issue or bpo exists in metadata

python · Nov 9, 2024 · 04b6913 · 04b6913
1 parent 657a617
commit 04b6913
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/src/blurb/blurb.py b/src/blurb/blurb.py
@@ -497,6 +497,9 @@ def finish_entry():
                     if value not in sections:
                         throw(f"Invalid section {value!r}!  You must use one of the predefined sections.")
 
+            if "gh-issue" not in metadata and "bpo" not in metadata:
+                throw("'gh-issue:' or 'bpo:' must be specified in the metadata!")
+
             if not 'section' in metadata:
                 throw("No 'section' specified.  You must provide one!")
 

diff --git a/tests/test_blurb.py b/tests/test_blurb.py
@@ -240,6 +240,10 @@ def test_parse():
             ".. gh-issue: 123456\n.. section: IDLE\n.. section: IDLE\nHello world!",
             r"Blurb metadata sets 'section' twice!",
         ),
+        (
+            ".. section: IDLE\nHello world!",
+            r"'gh-issue:' or 'bpo:' must be specified in the metadata!",
+        ),
     ),
 )
 def test_parse_no_body(contents, expected_error):