tools: validate commit list as part of lint-release-commit

PR-URL: #56291
Reviewed-By: James M Snell <jasnell@gmail.com>

Author: aduh95

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

@@ -33,30 +33,43 @@ jobs:
  echo "COMMIT_SUBJECT=$COMMIT_SUBJECT" >> "$GITHUB_ENV"
  - name: Lint release commit message trailers
 run: |
- EXPECTED_TRAILER="^PR-URL: $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/pull/[[:digit:]]+\$"
+ EXPECTED_TRAILER="^$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/pull/[[:digit:]]+\$"
  echo "Expected trailer format: $EXPECTED_TRAILER"
-ACTUAL="$(git --no-pager log -1 --format=%b | git interpret-trailers --parse --no-divider)"
+PR_URL="$(git --no-pager log -1 --format='%(trailers:key=PR-URL,valueonly)')"
  echo "Actual: $ACTUAL"
- echo "$ACTUAL" | grep -E -q "$EXPECTED_TRAILER"
+ echo "$PR_URL" | grep -E -q "$EXPECTED_TRAILER"
 
- PR_URL="${ACTUAL:8}"
  PR_HEAD="$(gh pr view "$PR_URL" --json headRefOid -q .headRefOid)"
  echo "Head of $PR_URL: $PR_HEAD"
  echo "Current commit: $GITHUB_SHA"
  [ "$PR_HEAD" = "$GITHUB_SHA" ]
 env:
 GH_TOKEN: ${{ github.token }}
+ - name: Verify it's release-ready
+run: |
+ SKIP_XZ=1 make release-only
  - name: Validate CHANGELOG
 id: releaser-info
 run: |
  EXPECTED_CHANGELOG_TITLE_INTRO="## $COMMIT_SUBJECT, @"
  echo "Expected CHANGELOG section title: $EXPECTED_CHANGELOG_TITLE_INTRO"
- CHANGELOG_TITLE="$(grep "$EXPECTED_CHANGELOG_TITLE_INTRO" "doc/changelogs/CHANGELOG_V${COMMIT_SUBJECT:20:2}.md")"
+ MAJOR="$(awk '/^#define NODE_MAJOR_VERSION / { print $3 }' src/node_version.h)"
+ CHANGELOG_PATH="doc/changelogs/CHANGELOG_V${MAJOR}.md"
+ CHANGELOG_TITLE="$(grep "$EXPECTED_CHANGELOG_TITLE_INTRO" "$CHANGELOG_PATH")"
  echo "Actual: $CHANGELOG_TITLE"
  [ "${CHANGELOG_TITLE%%@*}@" = "$EXPECTED_CHANGELOG_TITLE_INTRO" ]
- - name: Verify NODE_VERSION_IS_RELEASE bit is correctly set
-run: |
- grep -q '^#define NODE_VERSION_IS_RELEASE 1$' src/node_version.h
- - name: Check for placeholders in documentation
-run: |
- ! grep "REPLACEME" doc/api/*.md
+ gh api \
+ -H "Accept: application/vnd.github+json" \
+ -H "X-GitHub-Api-Version: 2022-11-28" \
+ --jq '.commits.[] | { smallSha: .sha[0:10] } + (.commit.message|capture("^(?<title>.+)\n\n(.*\n)*PR-URL: (?<prURL>.+)\n"))' \
+ "/repos/${GITHUB_REPOSITORY}/compare/v${MAJOR}.x...$GITHUB_SHA" --paginate \
+ | node tools/actions/lint-release-proposal-commit-list.mjs "$CHANGELOG_PATH" "$GITHUB_SHA" \
+ | while IFS= read -r PR_URL; do
+ LABEL="dont-land-on-v${MAJOR}.x" gh pr view \
+ --json labels,url \
+ --jq 'if (.labels|map(.name==env.LABEL)|any) then error("\(.url) has the \(env.LABEL) label, forbidding it to be in this release proposal") end' \
+ "$PR_URL" > /dev/null
+ done
+shell: bash # See https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#exit-codes-and-error-action-preference, we want the pipefail option.
+env:
+GH_TOKEN: ${{ github.token }}

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

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+
+// Takes a stream of JSON objects as inputs, validates the CHANGELOG contains a
+// line corresponding, then outputs the prURL value.
+//
+// Example:
+// $ git log upstream/vXX.x...upstream/vX.X.X-proposal \
+// --format='{"prURL":"%(trailers:key=PR-URL,valueonly,separator=)","title":"%s","smallSha":"%h"}' \
+// | ./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;
+
+importassertfrom'node:assert';
+import{readFile}from'node:fs/promises';
+import{createInterface}from'node:readline';
+
+// Creating the iterator early to avoid missing any data:
+conststdinLineByLine=createInterface(process.stdin)[Symbol.asyncIterator]();
+
+constchangelog=awaitreadFile(CHANGELOG_PATH,'utf-8');
+constcommitListingStart=changelog.indexOf('\n### Commits\n');
+constcommitListingEnd=changelog.indexOf('\n\n<a',commitListingStart);
+constcommitList=changelog.slice(commitListingStart,commitListingEnd===-1 ? undefined : commitListingEnd+1)
+// Checking for semverness is too expansive, it is left as a exercice for human reviewers.
+.replaceAll('**(SEMVER-MINOR)** ','')
+// Correct Markdown escaping is validated by the linter, getting rid of it here helps.
+.replaceAll('\\','');
+
+letexpectedNumberOfCommitsLeft=commitList.match(/\n\*\[/g).length;
+forawait(constlineofstdinLineByLine){
+const{ smallSha, title, prURL }=JSON.parse(line);
+
+if(smallSha===RELEASE_COMMIT_SHA.slice(0,10)){
+assert.strictEqual(
+expectedNumberOfCommitsLeft,0,
+'Some commits are listed without being included in the proposal, or are listed more than once',
+);
+continue;
+}
+
+constlineStart=commitList.indexOf(`\n* [[\`${smallSha}\`]`);
+assert.notStrictEqual(lineStart,-1,`Cannot find ${smallSha} on the list`);
+constlineEnd=commitList.indexOf('\n',lineStart+1);
+
+constcolonIndex=title.indexOf(':');
+constexpectedCommitTitle=`${`**${title.slice(0,colonIndex)}`.replace('**Revert "','_**Revert**_ "**')}**${title.slice(colonIndex)}`;
+try{
+assert(commitList.lastIndexOf(`/${smallSha})] - ${expectedCommitTitle} (`,lineEnd)>lineStart,'Commit title doesn\'t match');
+}catch(e){
+if(e?.code==='ERR_ASSERTION'){
+e.operator='includes';
+e.expected=expectedCommitTitle;
+e.actual=commitList.slice(lineStart+1,lineEnd);
+}
+throwe;
+}
+assert.strictEqual(commitList.slice(lineEnd-prURL.length-2,lineEnd),`(${prURL})`,`when checking ${smallSha}${title}`);
+
+expectedNumberOfCommitsLeft--;
+console.log(prURL);
+}
+assert.strictEqual(expectedNumberOfCommitsLeft,0,'Release commit is not the last commit in the proposal');