Ship the MIT notice in release artifacts

Author: gitcommit90

docs/release-checklist.md

@@ -104,6 +104,8 @@ MOUNT="$(hdiutil attach "$DMG" -nobrowse | awk '/\/Volumes\// {sub(/^.*\/Volumes
 trap 'hdiutil detach "$MOUNT" >/dev/null 2>&1 || true' EXIT
 
 codesign --verify --deep --strict "$MOUNT/ReRouted.app"
+test -f "$MOUNT/ReRouted.app/Contents/Resources/LICENSE"
+test -f "$MOUNT/LICENSE.txt"
 xcrun stapler validate "$MOUNT/ReRouted.app"
 spctl --assess --type execute --verbose=4 "$MOUNT/ReRouted.app"
 xcrun stapler validate "$DMG"
@@ -113,6 +115,7 @@ shasum -a 256 "$DMG"
 UPDATE_DIR="$(mktemp -d)"
 ditto -x -k "$UPDATE_ZIP" "$UPDATE_DIR"
 codesign --verify --deep --strict "$UPDATE_DIR/ReRouted.app"
+test -f "$UPDATE_DIR/ReRouted.app/Contents/Resources/LICENSE"
 xcrun stapler validate "$UPDATE_DIR/ReRouted.app"
 spctl --assess --type execute --verbose=4 "$UPDATE_DIR/ReRouted.app"
 shasum -a 256 "$UPDATE_ZIP"

scripts/package-mac-dmg.js

@@ -175,6 +175,7 @@ async function main() {
     extraResource: [
       path.join(ROOT, "resources", "trayTemplate.png"),
       path.join(ROOT, "resources", "trayTemplate@2x.png"),
+      path.join(ROOT, "LICENSE"),
     ].filter((p) => fs.existsSync(p)),
   });
 
@@ -185,6 +186,10 @@ async function main() {
 
   // Ensure tray icons land in Resources (packager extraResource is fine; belt & suspenders)
   const resDir = path.join(appPath, "Contents", "Resources");
+  const appLicense = path.join(resDir, "LICENSE");
+  if (!fs.existsSync(appLicense)) {
+    throw new Error("Packaged app is missing the MIT license notice");
+  }
   for (const f of ["trayTemplate.png", "trayTemplate@2x.png"]) {
     const src = path.join(ROOT, "resources", f);
     if (fs.existsSync(src)) fs.copyFileSync(src, path.join(resDir, f));
@@ -250,6 +255,7 @@ async function main() {
     const stagedApp = path.join(stage, `${PRODUCT}.app`);
     run("ditto", [appPath, stagedApp]);
     run("ln", ["-s", "/Applications", path.join(stage, "Applications")]);
+    fs.copyFileSync(path.join(ROOT, "LICENSE"), path.join(stage, "LICENSE.txt"));
 
     fs.writeFileSync(
       path.join(stage, "Install.txt"),

tests/release-artifacts.test.js

@@ -2,6 +2,8 @@
 
 const test = require("node:test");
 const assert = require("node:assert/strict");
+const fs = require("node:fs");
+const path = require("node:path");
 
 const { updateZipName, isRecognizedMacUpdateZip } = require("../scripts/release-artifacts");
 
@@ -16,3 +18,15 @@ test("rejects ZIP names the public update service cannot classify", () => {
   assert.equal(isRecognizedMacUpdateZip("ReRouted-0.3.1-mac-x64.zip"), false);
   assert.equal(isRecognizedMacUpdateZip("ReRouted-0.3.1-mac-arm64.dmg"), false);
 });
+
+test("declares MIT and includes its notice in packaged release copies", () => {
+  const root = path.resolve(__dirname, "..");
+  const pkg = JSON.parse(fs.readFileSync(path.join(root, "package.json"), "utf8"));
+  const license = fs.readFileSync(path.join(root, "LICENSE"), "utf8");
+  const packager = fs.readFileSync(path.join(root, "scripts", "package-mac-dmg.js"), "utf8");
+
+  assert.equal(pkg.license, "MIT");
+  assert.match(license, /^MIT License\n/);
+  assert.match(packager, /path\.join\(ROOT, "LICENSE"\)/);
+  assert.match(packager, /path\.join\(stage, "LICENSE\.txt"\)/);
+});