fix(ci): ignore HTML comments when validating linked issues

Author: ardelperal

.github/PULL_REQUEST_TEMPLATE.md

@@ -8,7 +8,7 @@
 
 Closes #
 
-<!-- Replace the # above with the issue number, e.g.: Closes #42 -->
+<!-- Replace the # above with the issue number, e.g.: Closes #<NUMBER> -->
 
 ---
 

.github/scripts/test-validate-pr-issue-references.js

@@ -0,0 +1,48 @@
+'use strict';
+
+const assert = require('node:assert/strict');
+const test = require('node:test');
+
+const {
+  extractLinkedIssueNumbers,
+} = require('./validate-pr-issue-references.js');
+
+test('extracts a single Closes #N reference', () => {
+  assert.deepEqual(extractLinkedIssueNumbers('Closes #1770'), [1770]);
+});
+
+test('strips a single-line HTML comment containing Closes #N', () => {
+  const body = '<!-- Closes #42 -->\nCloses #1770';
+
+  assert.deepEqual(extractLinkedIssueNumbers(body), [1770]);
+});
+
+test('strips a multi-line HTML comment', () => {
+  const body = [
+    '<!--',
+    'Closes #1',
+    'Fixes #2',
+    '-->',
+    'Resolves #1770',
+  ].join('\n');
+
+  assert.deepEqual(extractLinkedIssueNumbers(body), [1770]);
+});
+
+test('preserves multiple visible references', () => {
+  const body = 'Closes #1770\nResolves #123';
+
+  assert.deepEqual(extractLinkedIssueNumbers(body), [1770, 123]);
+});
+
+test('returns empty array when only HTML comments present', () => {
+  const body = '<!-- Closes #1 --><!-- Fixes #2\nResolves #3 -->';
+
+  assert.deepEqual(extractLinkedIssueNumbers(body), []);
+});
+
+test('treats closing references in code fences as visible', () => {
+  const body = '```markdown\nCloses #42\n```';
+
+  assert.deepEqual(extractLinkedIssueNumbers(body), [42]);
+});

.github/scripts/validate-pr-issue-references.js

@@ -0,0 +1,43 @@
+'use strict';
+
+const fs = require('node:fs');
+
+const HTML_COMMENT_PATTERN = /<!--[\s\S]*?-->/g;
+const CLOSING_REFERENCE_PATTERN = /(?:closes|fixes|resolves)\s+#(\d+)/gi;
+
+/**
+ * Remove HTML comments from a Markdown string.
+ *
+ * @param {string} markdown
+ * @returns {string}
+ */
+function stripHtmlComments(markdown) {
+  return markdown.replace(HTML_COMMENT_PATTERN, '');
+}
+
+/**
+ * Extract issue numbers from visible closing references in a PR body.
+ *
+ * @param {string} body
+ * @returns {number[]}
+ */
+function extractLinkedIssueNumbers(body) {
+  const visibleBody = stripHtmlComments(body);
+
+  return [...visibleBody.matchAll(CLOSING_REFERENCE_PATTERN)].map((match) =>
+    Number.parseInt(match[1], 10),
+  );
+}
+
+module.exports = {
+  extractLinkedIssueNumbers,
+  stripHtmlComments,
+};
+
+if (require.main === module) {
+  const body = process.argv.length > 2
+    ? process.argv.slice(2).join(' ')
+    : fs.readFileSync(0, 'utf8');
+
+  process.stdout.write(`${JSON.stringify(extractLinkedIssueNumbers(body))}\n`);
+}

.github/workflows/pr-check.yml

@@ -46,15 +46,17 @@ jobs:
     name: Check Issue Reference
     runs-on: ubuntu-latest
     steps:
+      - name: Check out repository
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd  # v5.0.1
       - name: Verify PR body references an issue
         uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b  # v7.1.0
         with:
           script: |
+            const { extractLinkedIssueNumbers } = require('./.github/scripts/validate-pr-issue-references.js');
             const body = context.payload.pull_request.body || '';
-            const pattern = /(?:closes|fixes|resolves)\s+#(\d+)/gi;
-            const matches = [...body.matchAll(pattern)];
+            const issueNumbers = extractLinkedIssueNumbers(body);
 
-            if (matches.length === 0) {
+            if (issueNumbers.length === 0) {
               core.setFailed(
                 '❌ PR body must reference a linked issue using one of:\n' +
                 '  - Closes #<number>\n' +
@@ -63,7 +65,7 @@ jobs:
                 'Every PR must be linked to an approved issue.'
               );
             } else {
-              const numbers = matches.map(m => `#${m[1]}`).join(', ');
+              const numbers = issueNumbers.map(issueNumber => `#${issueNumber}`).join(', ');
               console.log(`✅ Found issue reference(s): ${numbers}`);
             }
 
@@ -72,21 +74,22 @@ jobs:
     runs-on: ubuntu-latest
     needs: check-issue-reference
     steps:
+      - name: Check out repository
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd  # v5.0.1
       - name: Verify linked issue(s) have status:approved label
         uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b  # v7.1.0
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
+            const { extractLinkedIssueNumbers } = require('./.github/scripts/validate-pr-issue-references.js');
             const body = context.payload.pull_request.body || '';
-            const pattern = /(?:closes|fixes|resolves)\s+#(\d+)/gi;
-            const matches = [...body.matchAll(pattern)];
+            const issueNumbers = extractLinkedIssueNumbers(body);
 
-            if (matches.length === 0) {
+            if (issueNumbers.length === 0) {
               core.setFailed('❌ Could not find issue reference in PR body.');
               return;
             }
 
-            const issueNumbers = matches.map(m => parseInt(m[1], 10));
             const failures = [];
 
             for (const issueNumber of issueNumbers) {