Add docs deploy script

Signed-off-by: Andrew Stein <steinlink@gmail.com>

Author: texodus

docs/deploy.mjs

@@ -0,0 +1,68 @@
+// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+// ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
+// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
+// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
+// ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
+// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
+// ┃ Copyright (c) 2017, the Perspective Authors.                              ┃
+// ┃ ╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ ┃
+// ┃ This file is part of the Perspective library, distributed under the terms ┃
+// ┃ of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). ┃
+// ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+
+import * as fs from "node:fs";
+import * as path from "node:path";
+import { execFileSync } from "node:child_process";
+import { fileURLToPath } from "node:url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const REPO_ROOT = path.resolve(__dirname, "..");
+const DIST = path.join(__dirname, "dist");
+const STAGING = path.join(REPO_ROOT, "dist-gh-pages");
+const BRANCH = "gh-pages";
+
+function git(args, opts = {}) {
+    return execFileSync("git", args, {
+        stdio: "inherit",
+        cwd: REPO_ROOT,
+        ...opts,
+    });
+}
+
+function copyRecursive(src, dest) {
+    const stat = fs.statSync(src);
+    if (stat.isDirectory()) {
+        fs.mkdirSync(dest, { recursive: true });
+        for (const child of fs.readdirSync(src)) {
+            copyRecursive(path.join(src, child), path.join(dest, child));
+        }
+    } else {
+        fs.copyFileSync(src, dest);
+    }
+}
+
+if (!fs.existsSync(DIST)) {
+    console.error(`Missing ${DIST} — run \`npm run build\` first.`);
+    process.exit(1);
+}
+
+if (!fs.existsSync(STAGING)) {
+    git(["worktree", "add", STAGING, BRANCH]);
+} else {
+    git(["fetch", "origin", BRANCH]);
+    git(["checkout", `origin/${BRANCH}`], { cwd: STAGING });
+}
+
+// Clear tracked + untracked content in the staging worktree, preserving
+// the worktree's `.git` link.
+git(["rm", "-rf", "--quiet", "--ignore-unmatch", "."], { cwd: STAGING });
+git(["clean", "-fdx"], { cwd: STAGING });
+
+for (const entry of fs.readdirSync(DIST)) {
+    copyRecursive(path.join(DIST, entry), path.join(STAGING, entry));
+}
+
+git(["add", "-A"], { cwd: STAGING });
+
+console.log(`Staged dist/ onto ${BRANCH} at ${STAGING}`);
+console.log(`Review with \`git -C ${STAGING} status\`, then commit and push.`);

docs/package.json

@@ -8,6 +8,7 @@
         "start": "node server.mjs",
         "serve": "node server.mjs",
         "clean": "rm -rf dist",
+        "deploy": "node deploy.mjs",
         "mdbook": "docker compose run --rm mdbook build"
     },
     "dependencies": {

packages/viewer-charts/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@perspective-dev/viewer-charts",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "description": "Perspective.js WebGL Plugin",
     "unpkg": "./dist/cdn/perspective-viewer-charts.js",
     "jsdelivr": "./dist/cdn/perspective-viewer-charts.js",

tools/scripts/publish.mjs

@@ -12,6 +12,7 @@
 
 import { Octokit } from "octokit";
 import fs from "node:fs/promises";
+import { execSync } from "child_process";
 
 import "zx/globals";
 
@@ -62,6 +63,11 @@ async function download_release_assets(releases) {
     );
 }
 
+const SH_ENV = {
+    env: process.env,
+    stdio: "inherit",
+};
+
 async function publish_release_assets(releases) {
     if (process.env.COMMIT) {
         for (const release of releases) {
@@ -70,22 +76,45 @@ async function publish_release_assets(releases) {
                     release.name.endsWith("tar.gz")) &&
                 release.name.indexOf("wasm") === -1
             ) {
-                $.sync`twine upload ${release.name}`;
+                execSync(`twine upload ${release.name}`, SH_ENV);
             } else if (release.name.endsWith(".tgz")) {
-                $.sync`npm publish ${release.name}`;
+                execSync(`npm publish ${release.name}`, SH_ENV);
             } else {
                 console.log(`Skipping  "${release.name}"`);
             }
         }
 
         await $`mkdir -p rust/target/package && mv *.crate rust/target/package`;
 
-        await $`cargo publish -p perspective-server --allow-dirty --no-verify`;
-        await $`cargo publish -p perspective-client --allow-dirty --no-verify`;
-        await $`cargo publish -p perspective-python --allow-dirty --no-verify`;
-        await $`cargo publish -p perspective-js --allow-dirty --no-verify`;
-        await $`cargo publish -p perspective-viewer --allow-dirty --no-verify`;
-        await $`cargo publish -p perspective --allow-dirty --no-verify`;
+        execSync(
+            `cargo publish -p perspective-server --allow-dirty --no-verify`,
+            SH_ENV,
+        );
+
+        execSync(
+            `cargo publish -p perspective-client --allow-dirty --no-verify`,
+            SH_ENV,
+        );
+
+        execSync(
+            `cargo publish -p perspective-python --allow-dirty --no-verify`,
+            SH_ENV,
+        );
+
+        execSync(
+            `cargo publish -p perspective-js --allow-dirty --no-verify`,
+            SH_ENV,
+        );
+
+        execSync(
+            `cargo publish -p perspective-viewer --allow-dirty --no-verify`,
+            SH_ENV,
+        );
+
+        execSync(
+            `cargo publish -p perspective --allow-dirty --no-verify`,
+            SH_ENV,
+        );
     } else {
         console.warn(`COMMIT not specified, aborting`);
     }