feat: add zip script for packaging plugin releases

.github/workflows/release.yml

@@ -22,11 +22,14 @@ jobs:
 
       - name: Run Release Script
         run: bun run release
+
+      - name: Zip Release Artifacts
+        run: bun run zip
 
       - name: Upload Release Artifacts
         uses: ncipollo/release-action@v1
         with:
           allowUpdates: true
           omitBody: true
           omitName: true
-          artifacts: "packages/obsidian-plugin/main.js,packages/obsidian-plugin/manifest.json,packages/obsidian-plugin/styles.css,packages/mcp-server/dist/*"
+          artifacts: "packages/obsidian-plugin/releases/obsidian-plugin-*.zip,packages/obsidian-plugin/main.js,packages/obsidian-plugin/manifest.json,packages/obsidian-plugin/styles.css,packages/mcp-server/dist/*"

package.json

@@ -6,7 +6,8 @@
     "packages/*"
   ],
   "scripts": {
-    "release": "bun --filter '*' release"
+    "release": "bun --filter '*' release",
+    "zip": "bun --filter '*' zip"
   },
   "devDependencies": {
     "npm-run-all": "^4.1.5"

packages/obsidian-plugin/.gitignore

@@ -12,6 +12,7 @@ node_modules
 # They should be uploaded to GitHub releases instead.
 main.js
 bin
+releases/
 
 # Exclude sourcemaps
 *.map

packages/obsidian-plugin/package.json

@@ -17,11 +17,14 @@
 		"dev": "bun --watch run bun.config.ts --watch",
 		"link": "bun scripts/link.ts",
 		"version": "node version-bump.mjs && git add manifest.json versions.json",
-		"release": "run-s build"
+		"release": "run-s build zip",
+		"zip": "bun scripts/zip.ts"
 	},
 	"dependencies": {
+		"@types/fs-extra": "^11.0.4",
 		"arktype": "^2.0.0-rc.30",
 		"express": "^4.21.2",
+		"fs-extra": "^11.2.0",
 		"obsidian-local-rest-api": "^2.5.4",
 		"radash": "^12.1.0",
 		"rxjs": "^7.8.1",
@@ -32,6 +35,7 @@
 		"@types/node": "^16.11.6",
 		"@typescript-eslint/eslint-plugin": "5.29.0",
 		"@typescript-eslint/parser": "5.29.0",
+		"archiver": "^7.0.1",
 		"obsidian": "latest",
 		"tslib": "2.4.0",
 		"typescript": "^5.7.2"

packages/obsidian-plugin/scripts/zip.ts

@@ -0,0 +1,28 @@
+import { create } from "archiver";
+import { createWriteStream } from "fs";
+import fs from "fs-extra";
+import { join, resolve } from "path";
+import { version } from "../package.json" with { type: "json" };
+
+async function zipPlugin() {
+  const pluginDir = resolve(import.meta.dir, "..");
+
+  const releaseDir = join(pluginDir, "releases");
+  fs.ensureDirSync(releaseDir);
+
+  const zipFilePath = join(releaseDir, `obsidian-plugin-${version}.zip`);
+  const output = createWriteStream(zipFilePath);
+
+  const archive = create("zip", { zlib: { level: 9 } });
+  archive.pipe(output);
+
+  // Add the required files
+  archive.file(join(pluginDir, "main.js"), { name: "main.js" });
+  archive.file(join(pluginDir, "manifest.json"), { name: "manifest.json" });
+  archive.file(join(pluginDir, "styles.css"), { name: "styles.css" });
+
+  await archive.finalize();
+  console.log("Plugin files zipped successfully!");
+}
+
+zipPlugin().catch(console.error);