FIX Handle double underscored PR titles in changelog

silverstripe · Mar 5, 2024 · 0fe16d5 · 0fe16d5
1 parent 45d8d1a
commit 0fe16d5
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/src/Model/Changelog/ChangelogItem.php b/src/Model/Changelog/ChangelogItem.php
@@ -200,7 +200,7 @@ public function getRawMessage()
     }
 
     /**
-     * Gets message with type tag stripped
+     * Gets message with type tag stripped and some escaping to pass CI markdown linting
      *
      * @return string markdown safe string
      */
@@ -222,6 +222,22 @@ public function getShortMessage()
                 }
             }
         }
+        // Escape strings that will be incorrectly identified as markdown
+        $strings = [
+            '__CLASS__',
+            '__TRAIT__',
+            '__DIR__',
+            '__FILE__',
+            '__LINE__',
+            '__METHOD__',
+            '__FUNCTION__',
+            '__NAMESPACE__',
+        ];
+        foreach ($strings as $string) {
+            $message = str_replace($string, "`$string`", $message);
+            // Ensure that strings that were already correctly escaped are not double escaped
+            $message = str_replace("``$string``", "`$string`", $message);
+        }
 
         return $message;
     }

diff --git a/tests/Model/Changelog/ChangelogItemTest.php b/tests/Model/Changelog/ChangelogItemTest.php
@@ -100,6 +100,8 @@ public function messageProvider()
                 'Default fallback doesn\'t categorise commit',
                 'Other changes'
             ],
+            ['DOC Lorem __CLASS__ ipsum', 'Lorem `__CLASS__` ipsum', 'Documentation'],
+            ['DOC Lorem `__TRAIT__` ipsum', 'Lorem `__TRAIT__` ipsum', 'Documentation'],
         ];
     }