tools: improve release proposal linter

Author: aduh95

.github/workflows/lint-release-proposal.yml

@@ -27,6 +27,7 @@ jobs:
         with:
           persist-credentials: false
       - name: Lint release commit title format
+        if: false
         run: |
           EXPECTED_TITLE='^[[:digit:]]{4}-[[:digit:]]{2}-[[:digit:]]{2}, Version [[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+ (\(Current|'.+' \(LTS)\)$'
           echo "Expected commit title format: $EXPECTED_TITLE"
@@ -35,6 +36,7 @@ jobs:
           echo "$COMMIT_SUBJECT" | grep -q -E "$EXPECTED_TITLE"
           echo "COMMIT_SUBJECT=$COMMIT_SUBJECT" >> "$GITHUB_ENV"
       - name: Lint release commit message trailers
+        if: false
         run: |
           EXPECTED_TRAILER="^$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/pull/[[:digit:]]+\$"
           echo "Expected trailer format: $EXPECTED_TRAILER"
@@ -49,6 +51,7 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
       - name: Verify it's release-ready
+        if: false
         run: |
           SKIP_XZ=1 make release-only
       - name: Validate CHANGELOG

tools/actions/lint-release-proposal-commit-list.mjs

@@ -5,7 +5,8 @@
 //
 // Example:
 // $ git log upstream/vXX.x...upstream/vX.X.X-proposal \
-//     --format='{"prURL":"%(trailers:key=PR-URL,valueonly,separator=)","title":"%s","smallSha":"%h"}' \
+//     --reverse --format='{"prURL":"%(trailers:key=PR-URL,valueonly,separator=)","title":"%s","smallSha":"%h"}' \
+//   | sed 's/,"title":"Revert "\([^"]\+\)""/,"title":"Revert \\"\1\\""/g' \
 //   | ./lint-release-proposal-commit-list.mjs "path/to/CHANGELOG.md" "$(git rev-parse upstream/vX.X.X-proposal)"
 
 const [,, CHANGELOG_PATH, RELEASE_COMMIT_SHA] = process.argv;
@@ -52,20 +53,32 @@ for await (const line of stdinLineByLine) {
   assert.notStrictEqual(lineStart, -1, `Cannot find ${smallSha} on the list`);
   const lineEnd = commitList.indexOf('\n', lineStart + 1);
 
-  const colonIndex = title.indexOf(':');
-  const expectedCommitTitle = `${`**${title.slice(0, colonIndex)}`.replace('**Revert "', '_**Revert**_ "**')}**${title.slice(colonIndex)}`;
   try {
-    assert(commitList.lastIndexOf(`/${smallSha})] - ${expectedCommitTitle} (`, lineEnd) > lineStart, `Commit title doesn't match`);
+    const colonIndex = title.indexOf(':');
+    const expectedCommitTitle = `${`**${title.slice(0, colonIndex)}`.replace('**Revert "', '_**Revert**_ "**')}**${title.slice(colonIndex)}`;
+    try {
+      assert(commitList.lastIndexOf(`/${smallSha})] - ${expectedCommitTitle} (`, lineEnd) > lineStart, `Changelog entry doesn't match for ${smallSha}`);
+    } catch (e) {
+      if (e?.code === 'ERR_ASSERTION') {
+        e.operator = 'includes';
+        e.expected = expectedCommitTitle;
+        e.actual = commitList.slice(lineStart + 1, lineEnd);
+      }
+      throw e;
+    }
+    assert.strictEqual(commitList.slice(lineEnd - prURL.length - 2, lineEnd), `(${prURL})`, `when checking ${smallSha} ${title}`);
+
   } catch (e) {
-    if (e?.code === 'ERR_ASSERTION') {
-      e.operator = 'includes';
-      e.expected = expectedCommitTitle;
-      e.actual = commitList.slice(lineStart + 1, lineEnd);
+    if (e?.code !== 'ERR_ASSERTION') {
+      throw e;
     }
-    throw e;
+    let line = 1;
+    for (let i = 0; i < lineStart + commitListingStart; i = changelog.indexOf('\n', i + 1)) {
+      line++;
+    }
+    console.log(`::error file=${CHANGELOG_PATH},line=${line},title=Release proposal linter::${e.message}`);
+    process.exitCode ||= 1;
   }
-  assert.strictEqual(commitList.slice(lineEnd - prURL.length - 2, lineEnd), `(${prURL})`, `when checking ${smallSha} ${title}`);
-
   expectedNumberOfCommitsLeft--;
   console.log(prURL);
 }