Mirrors_Framework/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-05-23 23:18:00 +08:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

[ci] Prohibit curly braces in PR titles for MDX safety (#16412)

Browse Source
This commit is contained in:
J. Nick Koston
2026-05-13 21:03:45 -05:00
committed by GitHub
parent 78b60ac6fa
commit d2107e40c8
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/pr-title-check.yml
+7 -6
View File
@@ -68,14 +68,15 @@ jobs:
return;
}
// Check for angle brackets not wrapped in backticks.
// Astro docs MDX treats bare < as JSX component opening tags.
// Check for MDX syntax characters not wrapped in backticks.
// Astro docs MDX treats bare `<` as JSX component opening tags and
// bare `{` as JS expressions, so both must be escaped in changelog entries.
const stripped = title.replace(/`[^`]*`/g, '');
if (/[<>]/.test(stripped)) {
if (/[<>{}]/.test(stripped)) {
core.setFailed(
'PR title contains `<` or `>` not wrapped in backticks.\n' +
'Astro docs MDX interprets bare `<` as JSX components.\n' +
'Please wrap angle brackets with backticks, e.g.: [component] Add `<feature>` support'
'PR title contains `<`, `>`, `{`, or `}` not wrapped in backticks.\n' +
'Astro docs MDX interprets bare `<` as JSX components and bare `{` as JS expressions.\n' +
'Please wrap these characters with backticks, e.g.: [component] Add `<feature>` support'
);
return;
}