Generate changelogs per release

Author: orta

deploy/deployChangedPackages.mjs

@@ -12,6 +12,7 @@ import fetch from "node-fetch";
 import { spawnSync } from "child_process";
 import { Octokit } from "@octokit/core";
 import printDiff from "print-diff";
+import { generateChangelogFrom } from "../lib/changelog.js";
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
@@ -44,6 +45,9 @@ const go = async () => {
       .readdirSync(join(generatedDir, dirName))
       .filter((f) => f.endsWith(".d.ts"));
 
+    /** @type {string[]} */
+    let releaseNotes = [];
+
     // Look through each .d.ts file included in a package to
     // determine if anything has changed
     let upload = false;
@@ -57,6 +61,11 @@ const go = async () => {
         console.log(`Comparing ${file} from unpkg, to generated version:`);
         printDiff(npmDTSText, generatedDTSContent);
 
+        const title = `\n## \`${file}\`\n`;
+        const notes = generateChangelogFrom(npmDTSText, generatedDTSContent);
+        releaseNotes.push(title);
+        releaseNotes.push(notes.trim() === "" ? "No changes" : notes);
+
         upload = upload || npmDTSText !== generatedDTSContent;
       } catch (error) {
         // Could not find a previous build
@@ -93,8 +102,10 @@ Assuming that this means we need to upload this package.`);
 
       uploaded.push(dirName);
     }
-  }
 
+    console.log("\n# Release notes:");
+    console.log(releaseNotes.join("\n"), "\n\n");
+  }
   // Warn if we did a dry run.
   if (!process.env.NODE_AUTH_TOKEN) {
     console.log(
@@ -109,7 +120,7 @@ Assuming that this means we need to upload this package.`);
   }
 };
 
-async function createRelease(tag) {
+async function createRelease(tag, body) {
   const authToken = process.env.GITHUB_TOKEN || process.env.GITHUB_API_TOKEN;
   const octokit = new Octokit({ auth: authToken });
 
@@ -119,6 +130,7 @@ async function createRelease(tag) {
       repo: "TypeScript-DOM-lib-generator",
       tag_name: tag,
       target_commitish: process.env.GITHUB_SHA,
+      body,
     });
   } catch (error) {
     console.error(

src/changelog.ts

@@ -137,10 +137,17 @@ function writeAddedRemovedInline(added: Set<string>, removed: Set<string>) {
 
 const dom = "baselines/dom.generated.d.ts";
 
-export function generate(): string {
+export function generateDefaultFromRecentTag(): string {
   const [base = gitLatestTag(), head = "HEAD"] = process.argv.slice(2);
   const previous = gitShowFile(base, dom);
   const current = gitShowFile(head, dom);
+  return generateChangelogFrom(previous, current);
+}
+
+export function generateChangelogFrom(
+  previous: string,
+  current: string
+): string {
   const {
     interfaces: { added, removed, modified },
     others,
@@ -150,6 +157,7 @@ export function generate(): string {
   if (added.size || removed.size) {
     outputs.push(writeAddedRemoved(added, removed));
   }
+
   if (modified.size) {
     const modifiedOutput = [`## Modified\n`];
     for (const [key, value] of modified.entries()) {
@@ -169,14 +177,9 @@ export function generate(): string {
   }
 
   const output = outputs.join("\n\n");
-
-  if (!output.length) {
-    throw new Error(`No change reported between ${base} and ${head}.`);
-  }
-
   return output;
 }
 
 if (process.argv[1] === fileURLToPath(import.meta.url)) {
-  console.log(generate());
+  console.log(generateDefaultFromRecentTag());
 }

src/version.ts

@@ -1,8 +1,8 @@
 import { execSync } from "child_process";
 import { readFile, writeFile } from "fs/promises";
-import { generate } from "./changelog.js";
+import { generateDefaultFromRecentTag } from "./changelog.js";
 
-const output = generate();
+const output = generateDefaultFromRecentTag();
 
 const path = new URL("../CHANGELOG.md", import.meta.url);