build: updating npm publish script, creating zips for github releases

Author: matteobruni

.github/workflows/npm-publish.yml

@@ -7,7 +7,7 @@ on:
 
 permissions:
   id-token: write
-  contents: read
+  contents: write
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -16,6 +16,7 @@ concurrency:
 env:
   NX_CLOUD_DISTRIBUTED_EXECUTION: true
   NX_CLOUD_ACCESS_TOKEN: '${{ secrets.NX_CLOUD_ACCESS_TOKEN }}'
+  IS_STABLE: ${{ !contains(github.ref, '-alpha.') && !contains(github.ref, '-beta.') }}
 
 jobs:
   publish:
@@ -43,8 +44,7 @@ jobs:
 
       - name: Get pnpm store directory
         id: pnpm-cache
-        run: |
-          echo "pnpm_cache_dir=$(pnpm store path)" >> $GITHUB_OUTPUT
+        run: echo "pnpm_cache_dir=$(pnpm store path)" >> $GITHUB_OUTPUT
 
       - uses: actions/cache@v5
         name: Setup pnpm cache
@@ -62,10 +62,15 @@ jobs:
         env:
           CI: true
 
+      # 📦 ZIP artifacts (solo stable)
+      - name: Generate zip artifacts
+        if: env.IS_STABLE == 'true'
+        run: node scripts/package-zips.js
+
+      # 🚀 Publish npm
       - name: Publish to NPM (OIDC Auth)
         run: |
           TAG="${GITHUB_REF#refs/tags/}"
-          
           BASE_CMD="npx lerna publish from-package --ignore-scripts"
 
           echo "Publishing tag: $TAG via OIDC"
@@ -84,6 +89,30 @@ jobs:
             $BASE_CMD
           fi
 
+      # 🧠 Create release (raw GitHub notes)
+      - name: Create Release (raw)
+        if: env.IS_STABLE == 'true'
+        id: release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: release-artifacts/*.zip
+          generate_release_notes: true
+
+      # ✨ Prettify changelog → per package
+      - name: Prettify changelog
+        if: env.IS_STABLE == 'true'
+        run: |
+          echo "${{ steps.release.outputs.body }}" > RAW_RELEASE.md
+          node scripts/prettify-changelog.js
+
+      # 🔁 Update release con changelog finale
+      - name: Update Release Notes
+        if: env.IS_STABLE == 'true'
+        uses: softprops/action-gh-release@v2
+        with:
+          files: release-artifacts/*.zip
+          body_path: RELEASE_NOTES.md
+
       - name: Stop Nx Cloud Session
         run: npx nx fix-ci
         if: always()

scripts/package-zips.js

@@ -0,0 +1,72 @@
+import { execSync } from "node:child_process";
+import { readdirSync, existsSync, readFileSync, mkdirSync, rmSync } from "node:fs";
+import { join } from "node:path";
+
+const ROOT = process.cwd();
+const OUTPUT_DIR = join(ROOT, "release-artifacts");
+
+// Clean output directory
+rmSync(OUTPUT_DIR, { recursive: true, force: true });
+mkdirSync(OUTPUT_DIR, { recursive: true });
+
+/**
+ * Recursively find all directories containing a package.json
+ */
+function findPackages(dir) {
+  const entries = readdirSync(dir, { withFileTypes: true });
+  const packages = [];
+
+  for (const entry of entries) {
+    const fullPath = join(dir, entry.name);
+
+    if (entry.isDirectory()) {
+      const packageJsonPath = join(fullPath, "package.json");
+
+      if (existsSync(packageJsonPath)) {
+        packages.push(fullPath);
+      }
+
+      // Continue searching nested folders
+      packages.push(...findPackages(fullPath));
+    }
+  }
+
+  return packages;
+}
+
+/**
+ * Create a zip from a dist folder
+ */
+function createZip(distPath, outputZipPath) {
+  console.log(`📦 Creating ${outputZipPath}`);
+
+  execSync(`cd "${distPath}" && zip -r "${outputZipPath}" .`, {
+    stdio: "inherit",
+  });
+}
+
+// 🔍 Find all packages in repo
+const allPackages = findPackages(ROOT);
+
+for (const pkgPath of allPackages) {
+  const distPath = join(pkgPath, "dist");
+  const packageJsonPath = join(pkgPath, "package.json");
+
+  // Skip if no dist folder
+  if (!existsSync(distPath)) continue;
+
+  const pkgJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+
+  const name = pkgJson.name
+    .replace(/^@[^/]+\//, "") // remove scope if present
+    .replace(/\//g, "-"); // safety
+
+  const version = pkgJson.version;
+
+  const zipName = `${name}-${version}.zip`;
+  const zipPath = join(OUTPUT_DIR, zipName);
+
+  createZip(distPath, zipPath);
+}
+
+console.log("✅ All package archives created successfully.");

scripts/prettify-changelog.js.js

@@ -0,0 +1,90 @@
+import { execSync } from "node:child_process";
+import { readFileSync, writeFileSync } from "node:fs";
+
+// Read raw release notes generated by GitHub
+const raw = readFileSync("RAW_RELEASE.md", "utf-8");
+const lines = raw.split("\n");
+
+/**
+ * Map a file path to a logical package name.
+ * Adjusted for monorepo structure.
+ */
+function getPackageFromPath(filePath) {
+  const parts = filePath.split("/");
+
+  if (parts.length === 0) return null;
+
+  // Ignore demo folder
+  if (parts[0] === "demo") return null;
+
+  // Ignore test utilities
+  if (parts[0] === "utils" && parts[1] === "tests") return null;
+
+  // Single package
+  if (parts[0] === "engine") return "engine";
+
+  // Root utils (excluding tests)
+  if (parts[0] === "utils") return "utils";
+
+  // Generic structure: <group>/<package>
+  if (parts.length >= 2) {
+    return `${parts[0]}/${parts[1]}`;
+  }
+
+  return null;
+}
+
+/**
+ * Extract affected packages from a PR using GitHub CLI.
+ */
+function getPackagesFromPR(prNumber) {
+  try {
+    const result = execSync(`gh pr view ${prNumber} --json files`, { encoding: "utf-8" });
+
+    const files = JSON.parse(result).files;
+    const packages = new Set();
+
+    for (const file of files) {
+      const pkg = getPackageFromPath(file.path);
+      if (pkg) {
+        packages.add(pkg);
+      }
+    }
+
+    return [...packages];
+  } catch (error) {
+    console.warn(`Failed to fetch PR #${prNumber}:`, error.message);
+    return [];
+  }
+}
+
+let output = "";
+
+// Process each line of the generated release notes
+for (const line of lines) {
+  /**
+   * Match lines like:
+   * - Add new feature (#123)
+   */
+  const match = line.match(/- (.+?) \(#(\d+)\)/);
+
+  if (!match) {
+    output += line + "\n";
+    continue;
+  }
+
+  const [, text, prNumber] = match;
+
+  const packages = getPackagesFromPR(prNumber);
+
+  if (packages.length === 0) {
+    output += `- ${text}\n`;
+  } else {
+    output += `- ${text} (${packages.join(", ")})\n`;
+  }
+}
+
+// Write final formatted changelog
+writeFileSync("RELEASE_NOTES.md", output);
+
+console.log("✅ Changelog successfully enhanced with affected packages.");