Merge pull request #841 from XMOJ-Script-dev/codex/add-standardized-process-for-release-notes

Parse release notes from comment block

Author: boomzero

.github/workflows/UpdateToRelease.yml

@@ -5,6 +5,7 @@ on:
       - opened
       - reopened
       - synchronize
+      - edited
     branches:
       - master
 jobs:
@@ -24,7 +25,8 @@ jobs:
             gh pr comment ${{ github.event.pull_request.number }} --body "请向\`dev\`分支提交pull request, 本pull request将被自动关闭"
             gh pr close ${{ github.event.pull_request.number }}
           else
-            node ./Update/UpdateToRelease.js ${{ secrets.GITHUB_TOKEN }} ${{ github.event.number }}
+            node ./Update/UpdateToRelease.js ${{ secrets.GITHUB_TOKEN }} ${{ github.event.number }} "$PR_BODY"
           fi
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_BODY: ${{ github.event.pull_request.body }}

.github/workflows/UpdateVersion.yml

@@ -23,4 +23,6 @@ jobs:
           private-key: ${{ secrets.APP_PRIVATE_KEY }}
       - uses: actions/checkout@v5
       - name: Update version
-        run: node ./Update/UpdateVersion.js ${{ steps.generate_token.outputs.token }} ${{ github.event.number }} "${{ github.event.pull_request.title }}"
+        env:
+          PR_BODY: ${{ github.event.pull_request.body }}
+        run: node ./Update/UpdateVersion.js ${{ steps.generate_token.outputs.token }} ${{ github.event.number }} "${{ github.event.pull_request.title }}" "$PR_BODY"

CONTRIBUTING.md

@@ -18,3 +18,4 @@ We believe that you must be excited to contribute to our repo, but first, please
 - Be patient. We are a small team and may not be able to review your PR immediately.
 - Please be considerate towards the developers and other users when raising issues or presenting pull requests.
 - Respect our decision(s), and do not be upset or abusive if your submission is not used.
+- For release pull requests, include an HTML comment block starting with `<!-- release-notes` and ending with `-->` in the PR description. The automation will extract that block into the release notes.

Update/UpdateToRelease.js

@@ -3,6 +3,13 @@ import {execSync} from "child_process";
 
 var GithubToken = process.argv[2];
 var PRNumber = process.argv[3];
+function extractReleaseNotes(body) {
+    const match = body
+        .replace(/\r\n/g, "\n")
+        .match(/<!--\s*release[- ]notes\s*([\s\S]*?)-->/i);
+    return match ? match[1].trim() : "";
+}
+var CurrentNotes = extractReleaseNotes(String(process.argv[4] || ""));
 process.env.GITHUB_TOKEN = GithubToken;
 execSync("gh pr checkout " + PRNumber);
 console.info("PR #" + PRNumber + " has been checked out.");
@@ -45,6 +52,7 @@ console.log("Last JSON version  : " + LastJSONVersion);
 console.log("Last PR            : " + LastPR);
 console.log("Last type          : " + LastType);
 console.log("npm version        : " + NpmVersion);
+console.log("Current notes      : " + (CurrentNotes || "No release notes were provided for this release."));
 
 if (LastJSONVersion != LastJSVersion) {
     console.error("XMOJ.user.js and Update.json have different patch versions.");
@@ -67,7 +75,7 @@ JSONObject.UpdateHistory[CurrentVersion] = {
     "UpdateDate": Date.now(),
     "Prerelease": false,
     "UpdateContents": [],
-    "Notes": "No release notes were provided for this release."
+    "Notes": CurrentNotes || "No release notes were provided for this release."
 };
 
 for (var i = Object.keys(JSONObject.UpdateHistory).length - 2; i >= 0; i--) {

Update/UpdateVersion.js

@@ -47,6 +47,13 @@ execSync("git config --global user.email \"github-actions[bot]@users.noreply.git
 execSync("git config --global user.name \"github-actions[bot]\"");
 var CurrentPR = Number(PRNumber);
 var CurrentDescription = String(process.argv[4]);
+function extractReleaseNotes(body) {
+    const match = body
+        .replace(/\r\n/g, "\n")
+        .match(/<!--\s*release[- ]notes\s*([\s\S]*?)-->/i);
+    return match ? match[1].trim() : "";
+}
+var CurrentNotes = extractReleaseNotes(String(process.argv[5] || ""));
 if (LastJSVersion != NpmVersion) {
     console.warn("Assuming you manually ran npm version.");
 } else if (!(LastPR == CurrentPR && NpmVersion == LastJSVersion)) {
@@ -58,6 +65,7 @@ var CurrentVersion = execSync("jq -r '.version' package.json").toString().trim()
 console.log("Current version    : " + CurrentVersion);
 console.log("Current PR         : " + CurrentPR);
 console.log("Current description: " + CurrentDescription);
+console.log("Current notes      : " + (CurrentNotes || "No release notes were provided for this release."));
 
 var ChangedFileList = execSync("gh pr diff " + CurrentPR + " --name-only").toString().trim().split("\n");
 console.log("Changed files      : " + ChangedFileList.join(", "));
@@ -67,6 +75,9 @@ if (LastPR == CurrentPR && NpmVersion == LastJSVersion) {
     console.warn("Warning: PR is the same as last version.");
     JSONObject.UpdateHistory[LastJSVersion].UpdateDate = Date.now();
     JSONObject.UpdateHistory[LastJSVersion].UpdateContents[0].Description = CurrentDescription;
+    if (CurrentNotes) {
+        JSONObject.UpdateHistory[LastJSVersion].Notes = CurrentNotes;
+    }
     CommitMessage = "Update time and description of " + LastJSVersion;
 } else if (ChangedFileList.indexOf("XMOJ.user.js") == -1) {
     console.warn("XMOJ.user.js is not changed, so the version should not be updated.");
@@ -79,7 +90,7 @@ if (LastPR == CurrentPR && NpmVersion == LastJSVersion) {
             "PR": CurrentPR,
             "Description": CurrentDescription
         }],
-        "Notes": "No release notes were provided for this release."
+        "Notes": CurrentNotes || "No release notes were provided for this release."
     };
     writeFileSync(JSFileName, JSFileContent.replace(/@version(\s+)\d+\.\d+\.\d+/, "@version$1" + CurrentVersion), "utf8");
     console.warn("XMOJ.user.js has been updated.");