Saner Releases - improve changelog merging & allow pre-public testing…

… (pack) (matrix-org#4043) * Switch prepublishOnly to prepack to catch errors earlier Signed-off-by: Michael Telatynski <[email protected]> * Fix merge-release-notes.js parsing Signed-off-by: Michael Telatynski <[email protected]> * Discard changes to yarn.lock * Update package.json --------- Signed-off-by: Michael Telatynski <[email protected]>
verji · Feb 1, 2024 · b46b315 · b46b315
1 parent 8007bc5
commit b46b315
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 39 deletions.
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
         "node": ">=18.0.0"
     },
     "scripts": {
-        "prepublishOnly": "yarn build",
+        "prepack": "yarn build",
         "start": "echo THIS IS FOR LEGACY PURPOSES ONLY. && babel src -w -s -d lib --verbose --extensions \".ts,.js\"",
         "clean": "rimraf lib",
         "build": "yarn build:dev",

diff --git a/scripts/release/merge-release-notes.js b/scripts/release/merge-release-notes.js
@@ -26,24 +26,38 @@ async function getRelease(github, dependency) {
 
 const HEADING_PREFIX = "## ";
 
+const categories = [
+    "🔒 SECURITY FIXES",
+    "🚨 BREAKING CHANGESd",
+    "🦖 Deprecations",
+    "✨ Features",
+    "🐛 Bug Fixes",
+    "🧰 Maintenance",
+];
+
+const parseReleaseNotes = (body, sections) => {
+    let heading = null;
+    for (const line of body.split("\n")) {
+        const trimmed = line.trim();
+        if (trimmed.startsWith(HEADING_PREFIX)) {
+            heading = trimmed.slice(HEADING_PREFIX.length);
+            if (!categories.includes(heading)) heading = null;
+            continue;
+        }
+        if (heading && trimmed) {
+            sections[heading].push(trimmed);
+        }
+    }
+};
+
 const main = async ({ github, releaseId, dependencies }) => {
     const { GITHUB_REPOSITORY } = process.env;
     const [owner, repo] = GITHUB_REPOSITORY.split("/");
 
-    const sections = new Map();
-    let heading = null;
+    const sections = Object.fromEntries(categories.map((cat) => [cat, []]));
     for (const dependency of dependencies) {
         const release = await getRelease(github, dependency);
-        for (const line of release.body.split("\n")) {
-            if (line.startsWith(HEADING_PREFIX)) {
-                heading = line.trim();
-                sections.set(heading, []);
-                continue;
-            }
-            if (heading && line) {
-                sections.get(heading).push(line.trim());
-            }
-        }
+        parseReleaseNotes(release.body, sections);
     }
 
     const { data: release } = await github.rest.repos.getRelease({
@@ -52,36 +66,22 @@ const main = async ({ github, releaseId, dependencies }) => {
         release_id: releaseId,
     });
 
-    const headings = ["🚨 BREAKING CHANGES", "🦖 Deprecations", "✨ Features", "🐛 Bug Fixes", "🧰 Maintenance"].map(
-        (h) => HEADING_PREFIX + h,
-    );
+    const intro = release.body.split(HEADING_PREFIX, 2)[0].trim();
 
-    heading = null;
-    const output = [];
-    for (const line of [...release.body.split("\n"), null]) {
-        if (line === null || line.startsWith(HEADING_PREFIX)) {
-            // If we have a heading, and it's not the first in the list of pending headings, output the section.
-            // If we're processing the last line (null) then output all remaining sections.
-            while (headings.length > 0 && (line === null || (heading && headings[0] !== heading))) {
-                const heading = headings.shift();
-                if (sections.has(heading)) {
-                    output.push(heading);
-                    output.push(...sections.get(heading));
-                }
-            }
+    let output = "";
+    if (intro) {
+        output = intro + "\n\n";
+    }
 
-            if (heading && sections.has(heading)) {
-                const lastIsBlank = !output.at(-1)?.trim();
-                if (lastIsBlank) output.pop();
-                output.push(...sections.get(heading));
-                if (lastIsBlank) output.push("");
-            }
-            heading = line;
-        }
-        output.push(line);
+    for (const section in sections) {
+        const lines = sections[section];
+        if (!lines.length) continue;
+        output += HEADING_PREFIX + section + "\n\n";
+        output += lines.join("\n");
+        output += "\n\n";
     }
 
-    return output.join("\n");
+    return output;
 };
 
 // This is just for testing locally