Merge pull request #6294 from nilsvu/fix_release_notes

Fix release notes for empty PR description
sxs-collaboration · Sep 24, 2024 · 9f9dc2c · 9f9dc2c
2 parents 785d70c + e300b14
commit 9f9dc2c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/tests/tools/Test_CompileReleaseNotes.py b/tests/tools/Test_CompileReleaseNotes.py
@@ -113,6 +113,8 @@ def test_get_upgrade_instructions(self):
             "Do this and that.",
             "Not all whitespace is stripped",
         )
+        self.assertIsNone(get_upgrade_instructions(""))
+        self.assertIsNone(get_upgrade_instructions(None))
 
     def test_compile_release_notes(self):
         self.assertEqual(

diff --git a/tools/CompileReleaseNotes.py b/tools/CompileReleaseNotes.py
@@ -124,6 +124,8 @@ def get_upgrade_instructions(pr_description: str) -> Optional[str]:
     <!-- UPGRADE INSTRUCTIONS -->
     ```
     """
+    if not pr_description:
+        return None
     FENCE_PATTERN = "<!-- UPGRADE INSTRUCTIONS -->"
     match = re.search(
         FENCE_PATTERN + "(.*)" + FENCE_PATTERN, pr_description, flags=re.DOTALL