Improve suffix parsing in issue_pattern (#654)

twisted · Aug 6, 2024 · 543db79 · 543db79
2 parents 30ac2d3 + f551413
commit 543db79
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/src/towncrier/_builder.py b/src/towncrier/_builder.py
@@ -176,14 +176,11 @@ def find_fragments(
                 # Use and increment the orphan news fragment counter.
                 counter = orphan_fragment_counter[category]
                 orphan_fragment_counter[category] += 1
-            if config.issue_pattern and (
-                not re.fullmatch(
-                    config.issue_pattern, issue_name := Path(basename).stem
-                )
-            ):
+
+            if config.issue_pattern and not re.fullmatch(config.issue_pattern, issue):
                 raise ClickException(
-                    f"File name '{issue_name}' does not match the "
-                    f"given issue pattern, '{config.issue_pattern}'"
+                    f"Issue name '{issue}' does not match the "
+                    f"configured pattern, '{config.issue_pattern}'"
                 )
             full_filename = os.path.join(section_dir, basename)
             fragment_files.append((full_filename, category))

diff --git a/src/towncrier/newsfragments/654.bugfix.rst b/src/towncrier/newsfragments/654.bugfix.rst
@@ -0,0 +1 @@
+Fixed an issue where `issue_template` failed recognizing the issue name of files with a non-category suffix (`.md`)
diff --git a/src/towncrier/test/test_check.py b/src/towncrier/test/test_check.py
@@ -530,7 +530,7 @@ def test_issue_pattern(self, runner):
             extra_config='issue_pattern = "\\\\d+"',
         )
         write(
-            "foo/newsfragments/AAA.BBB.feature",
+            "foo/newsfragments/AAA.BBB.feature.md",
             "This fragment has an invalid name (should be digits only)",
         )
         write(
@@ -542,10 +542,14 @@ def test_issue_pattern(self, runner):
         result = runner.invoke(towncrier_check, ["--compare-with", "main"])
         self.assertEqual(1, result.exit_code, result.output)
         self.assertIn(
-            "Error: File name 'AAA.BBB' does not match the given issue pattern, '\\d+'",
+            "Error: Issue name 'AAA.BBB' does not match the configured pattern, '\\d+'",
             result.output,
         )
         self.assertNotIn(
-            "Error: File name '123' does not match the given issue pattern, '\\d+'",
+            "Error: Issue '123' does not match the configured pattern, '\\d+'",
+            result.output,
+        )
+        self.assertNotIn(
+            "Error: Issue '123.feature' does not match the configured pattern, '\\d+'",
             result.output,
         )