@arcadible/github-release-tools 1.0.2 → 1.0.4

package/README.md

@@ -13,25 +13,26 @@
 <p align="center">
   <a href="https://developer.arcadible.com/publish/deploying-from-github">Docs</a> ·
   <a href="https://www.npmjs.com/package/arcadible">Arcadible CLI</a> ·
-  <a href="https://arcadible.com">Arcadible</a>
+  <a href="https://arcadible.com">Arcadible</a> ·
+  <a href="https://studio.arcadible.com">Studio</a>
 </p>
 
 <br>
 
-When `arc deploy git` pushes a release tag, the Arcadible Release workflow builds the game on GitHub Actions. It installs this package alongside the [Arcadible CLI](https://www.npmjs.com/package/arcadible) and uses its `arctool-*` commands to read the game's manifest. You don't need to install it yourself.
+When `arc deploy git` pushes a release tag, the Arcadible Release workflow builds the game on GitHub Actions. It installs this package alongside the [Arcadible CLI](https://www.npmjs.com/package/arcadible), on Node.js 24, and runs its `arctool-*` commands between the CLI's. You don't need to install it yourself.
 
-| Command                  | What it does                                                          |
-| ------------------------ | --------------------------------------------------------------------- |
-| `arctool-assert-tag`     | Checks that the release tag matches the manifest's version            |
-| `arctool-assert-dir`     | Checks that the build produced the deploy directory                   |
-| `arctool-put-version`    | Outputs the manifest's version                                        |
-| `arctool-put-prerelease` | Outputs whether the version is a prerelease                           |
-| `arctool-put-build`      | Outputs the build command                                             |
-| `arctool-put-deploy-dir` | Outputs the deploy directory                                          |
-| `arctool-put-cache`      | Outputs the package manager to cache, from the project's lockfile     |
-| `arctool-install-deps`   | Installs the project's dependencies exactly as its lockfile pins them |
+| Command                               | What it does                                                               |
+| ------------------------------------- | -------------------------------------------------------------------------- |
+| `arctool-assert-tag <manifest> <tag>` | Checks that the tag is `arcadible/release/v<version>`, with the manifest's |
+| `arctool-assert-dir <dir>`            | Checks that the build wrote the deploy directory, a folder                 |
+| `arctool-put-version <manifest>`      | Outputs `version`, the manifest's                                          |
+| `arctool-put-prerelease <manifest>`   | Outputs `prerelease`, whether the version is a prerelease                  |
+| `arctool-put-build <manifest>`        | Outputs `build`, the build command on one line, or nothing without one     |
+| `arctool-put-deploy-dir <manifest>`   | Outputs `deploy_dir`                                                       |
+| `arctool-put-cache <manifest>`        | Outputs `cache`, the package manager whose lockfile is beside the manifest |
+| `arctool-install-deps <dir>`          | Installs the project's dependencies exactly as its lockfile pins them      |
 
-Each `put` command writes its value to the step's `GITHUB_OUTPUT`. `arctool-install-deps` runs `npm ci`, or pnpm or Yarn through corepack, and does nothing without a lockfile.
+`<manifest>` is the file `arc inspect --json` writes. Each `put` command writes its value to the step's `GITHUB_OUTPUT`. `arctool-install-deps` runs `npm ci`, or pnpm or Yarn through corepack, and does nothing without a lockfile. A command that fails says why on stderr, and exits 1.
 
 ## License
 

package/bin/arctool-assert-dir.sh

@@ -2,8 +2,4 @@
 set -e
 SCRIPT="$(realpath "$0")"
 DIR="$(dirname "$SCRIPT")"
-RESULT=$(node "$DIR/../src/assert-dir.js" "$1")
-if [ "$RESULT" != "true" ]; then
-  echo "Unable to find: $1"
-  exit 1
-fi
+node "$DIR/../src/assert-dir.js" "$@"

package/bin/arctool-assert-tag.sh

@@ -2,8 +2,4 @@
 set -e
 SCRIPT="$(realpath "$0")"
 DIR="$(dirname "$SCRIPT")"
-RESULT=$(node "$DIR/../src/assert-tag.js" "$1" "$2")
-if [ "$RESULT" != "true" ]; then
-  echo "Invalid tag: $2"
-  exit 1
-fi
+node "$DIR/../src/assert-tag.js" "$@"

package/package.json

@@ -32,5 +32,5 @@
   "scripts": {
     "test": "node --test \"test/**/*.test.js\""
   },
-  "version": "1.0.2"
+  "version": "1.0.4"
 }

package/src/assert-dir.js

@@ -1,30 +1,35 @@
 "use strict";
+// arctool-assert-dir <dir>: passes when the build wrote deploy_dir, a folder.
 
 // [import]
 
 const fs = require("node:fs");
 
+// [import]
+
+const io = require("./io");
+
 // [use]
 
-const existsSync = fs.existsSync; // eslint-disable-line no-sync
+const fail = io.fail;
+const run = io.run;
+const statSync = fs.statSync; // eslint-disable-line no-sync
 
 // [define]
 
 const dir = process.argv[2];
 
-// [function]
-
-const write = function (data) {
-  process.stdout.write(data.trim().concat("\n"));
-};
-
 // [main]
 
-try {
+run(() => {
   if (!dir) {
-    throw new Error("No directory provided.");
+    fail("No directory provided.");
+  }
+  const info = statSync(dir, { throwIfNoEntry: false });
+  if (!info) {
+    fail(`Unable to find: ${dir}`, "The build didn't write deploy_dir.");
+  }
+  if (!info.isDirectory()) {
+    fail(`Unable to find: ${dir}`, "It's a file, and deploy_dir is a folder.");
   }
-  write(existsSync(dir) ? "true" : "false");
-} catch {
-  write("false");
-}
+});

package/src/assert-tag.js

@@ -1,51 +1,47 @@
 "use strict";
+// arctool-assert-tag <manifest> <tag>: passes when the tag is
+// arcadible/release/v<version>, with the manifest's version.
 
 // [import]
 
-const fs = require("node:fs");
+const semver = require("semver");
 
 // [import]
 
-const semver = require("semver");
+const io = require("./io");
 
 // [use]
 
-const cleanSemver = semver.clean;
-const readFileSync = fs.readFileSync; // eslint-disable-line no-sync
+const fail = io.fail;
+const readManifest = io.readManifest;
+const run = io.run;
 const validSemver = semver.valid;
 
+// [declare]
+
+const PREFIX = "arcadible/release/v";
+
 // [define]
 
 const file = process.argv[2];
 const tag = process.argv[3];
 
-// [function]
-
-const write = function (data) {
-  process.stdout.write(data.trim().concat("\n"));
-};
-
 // [main]
 
-try {
-  if (!file) {
-    throw new Error("No file provided.");
-  }
+run(() => {
   if (!tag) {
-    throw new Error("No tag provided.");
+    fail("No tag provided.");
+  }
+  const invalid = `Invalid tag: ${tag}`;
+  if (!tag.startsWith(PREFIX)) {
+    fail(invalid, `A release tag is ${PREFIX}<version>.`);
+  }
+  const release = validSemver(tag.slice(PREFIX.length));
+  if (!release) {
+    fail(invalid, `${tag.slice(PREFIX.length)} isn't a version.`);
   }
-  if (!tag.startsWith("arcadible/release/v")) {
-    throw new Error("Invalid tag prefix.");
+  const version = validSemver(readManifest(file)?.game?.version);
+  if (release !== version) {
+    fail(invalid, `The project's version is ${version ?? "not set"}.`);
   }
-  const buf = readFileSync(file, "utf8");
-  const conf = JSON.parse(buf);
-  const version = validSemver(conf?.game?.version);
-  const release = cleanSemver(tag.split("/").pop());
-  write(
-    version !== null && release !== null && version === release
-      ? "true"
-      : "false",
-  );
-} catch {
-  write("false");
-}
+});

package/src/install-deps.js

@@ -7,9 +7,12 @@ const cp = require("node:child_process");
 // [import]
 
 const detect = require("./lockfile");
+const io = require("./io");
 
 // [use]
 
+const fail = io.fail;
+const run = io.run;
 const spawnSync = cp.spawnSync; // eslint-disable-line no-sync
 
 // [declare]
@@ -27,34 +30,26 @@ const COMMANDS = {
 
 const dir = process.argv[2];
 
-// [function]
-
-const writeErr = function (data) {
-  process.stderr.write(data.trim().concat("\n"));
-};
-
 // [main]
 
-try {
+run(() => {
   if (!dir) {
-    throw new Error("No directory provided.");
+    fail("No directory provided.");
   }
   const manager = detect(dir);
-  if (manager) {
-    const [command, args] = COMMANDS[manager];
-    const { error, status } = spawnSync(command, args, {
-      cwd: dir,
-      env: { ...process.env, COREPACK_ENABLE_DOWNLOAD_PROMPT: "0" },
-      stdio: "inherit",
-    });
-    if (error) {
-      throw error;
-    }
-    if (status !== 0) {
-      process.exit(status ?? 1);
-    }
+  if (!manager) {
+    return;
+  }
+  const [command, args] = COMMANDS[manager];
+  const { error, status } = spawnSync(command, args, {
+    cwd: dir,
+    env: { ...process.env, COREPACK_ENABLE_DOWNLOAD_PROMPT: "0" },
+    stdio: "inherit",
+  });
+  if (error) {
+    throw error;
+  }
+  if (status !== 0) {
+    process.exit(status ?? 1);
   }
-} catch (ex) {
-  writeErr(ex.message);
-  process.exit(1);
-}
+});

package/src/io.js

@@ -0,0 +1,56 @@
+"use strict";
+// what every arctool command shares: its result on stdout, which the bash
+// wrapper writes to $GITHUB_OUTPUT, and a failure on stderr, in arc's shape
+// (the CLI's OUTPUT.md): what failed, then why.
+
+// [import]
+
+const fs = require("node:fs");
+
+// [use]
+
+const readFileSync = fs.readFileSync; // eslint-disable-line no-sync
+
+// [function]
+
+// writes `data` to stdout, one line.
+const write = function (data) {
+  process.stdout.write(String(data).trim().concat("\n"));
+};
+
+// [function]
+
+// writes `lines` to stderr, then exits 1.
+const fail = function (...lines) {
+  process.stderr.write(lines.join("\n").trim().concat("\n"));
+  process.exit(1);
+};
+
+// [function]
+
+// the resolved manifest `arc inspect --json` wrote to `file`.
+const readManifest = function (file) {
+  if (!file) {
+    return fail("No manifest file provided.");
+  }
+  try {
+    return JSON.parse(readFileSync(file, "utf8"));
+  } catch (ex) {
+    return fail(`Unable to read ${file}.`, ex.message);
+  }
+};
+
+// [function]
+
+// runs `main`, turning anything it throws into a failure.
+const run = function (main) {
+  try {
+    main();
+  } catch (ex) {
+    fail(ex.message);
+  }
+};
+
+// [export]
+
+module.exports = { fail, readManifest, run, write };

package/src/put-build.js

@@ -1,49 +1,32 @@
 "use strict";
+// arctool-put-build <manifest>: the build command, on one line, or nothing
+// when there's none. The workflow only asks whether there is one; a command on
+// several lines would break $GITHUB_OUTPUT, so its lines are joined with &&.
 
 // [import]
 
-const fs = require("node:fs");
+const io = require("./io");
 
 // [use]
 
-const readFileSync = fs.readFileSync; // eslint-disable-line no-sync
+const readManifest = io.readManifest;
+const run = io.run;
+const write = io.write;
 
 // [define]
 
 const file = process.argv[2];
 
-// [function]
-
-const write = function (data) {
-  process.stdout.write(data.trim().concat("\n"));
-};
-
-// [function]
-
-const writeErr = function (data) {
-  process.stderr.write(data.trim().concat("\n"));
-};
-
 // [main]
 
-try {
-  if (!file) {
-    throw new Error("No file provided.");
-  }
-  const buf = readFileSync(file, "utf8");
-  const conf = JSON.parse(buf);
-  const build = conf?.workflow?.build ?? "";
-  if (Array.isArray(build)) {
-    write(
-      build
-        .map((command) => command.trim())
-        .filter(Boolean)
-        .join(" && "),
-    );
-  } else {
-    write(build.trim());
-  }
-} catch (ex) {
-  writeErr(ex.message);
-  process.exit(1);
-}
+run(() => {
+  const build = readManifest(file)?.workflow?.build ?? "";
+  write(
+    [build]
+      .flat()
+      .flatMap((command) => String(command).split("\n"))
+      .map((command) => command.trim())
+      .filter(Boolean)
+      .join(" && "),
+  );
+});

package/src/put-cache.js

@@ -1,4 +1,6 @@
 "use strict";
+// arctool-put-cache <manifest>: the package manager whose lockfile is beside
+// the manifest's project, for setup-node's cache, or nothing.
 
 // [import]
 
@@ -7,35 +9,24 @@ const path = require("node:path");
 // [import]
 
 const detect = require("./lockfile");
+const io = require("./io");
 
 // [use]
 
 const dirname = path.dirname;
+const fail = io.fail;
+const run = io.run;
+const write = io.write;
 
 // [define]
 
 const file = process.argv[2];
 
-// [function]
-
-const write = function (data) {
-  process.stdout.write(data.trim().concat("\n"));
-};
-
-// [function]
-
-const writeErr = function (data) {
-  process.stderr.write(data.trim().concat("\n"));
-};
-
 // [main]
 
-try {
+run(() => {
   if (!file) {
-    throw new Error("No file provided.");
+    fail("No manifest file provided.");
   }
   write(detect(dirname(file)));
-} catch (ex) {
-  writeErr(ex.message);
-  process.exit(1);
-}
+});

package/src/put-deploy-dir.js

@@ -1,39 +1,23 @@
 "use strict";
+// arctool-put-deploy-dir <manifest>: deploy_dir, which arc inspect always
+// gives, its default included.
 
 // [import]
 
-const fs = require("node:fs");
+const io = require("./io");
 
 // [use]
 
-const readFileSync = fs.readFileSync; // eslint-disable-line no-sync
+const readManifest = io.readManifest;
+const run = io.run;
+const write = io.write;
 
 // [define]
 
 const file = process.argv[2];
 
-// [function]
-
-const write = function (data) {
-  process.stdout.write(data.trim().concat("\n"));
-};
-
-// [function]
-
-const writeErr = function (data) {
-  process.stderr.write(data.trim().concat("\n"));
-};
-
 // [main]
 
-try {
-  if (!file) {
-    throw new Error("No file provided.");
-  }
-  const buf = readFileSync(file, "utf8");
-  const conf = JSON.parse(buf);
-  write(conf?.workflow?.deploy_dir || ".arcadible-public");
-} catch (ex) {
-  writeErr(ex.message);
-  process.exit(1);
-}
+run(() => {
+  write(readManifest(file)?.workflow?.deploy_dir ?? "");
+});

package/src/put-prerelease.js

@@ -1,48 +1,30 @@
 "use strict";
+// arctool-put-prerelease <manifest>: whether the version is a prerelease,
+// which goes to staging.
 
 // [import]
 
-const fs = require("node:fs");
+const semver = require("semver");
 
 // [import]
 
-const semver = require("semver");
+const io = require("./io");
 
 // [use]
 
 const prereleaseSemver = semver.prerelease;
-const readFileSync = fs.readFileSync; // eslint-disable-line no-sync
+const readManifest = io.readManifest;
+const run = io.run;
 const validSemver = semver.valid;
+const write = io.write;
 
 // [define]
 
 const file = process.argv[2];
 
-// [function]
-
-const write = function (data) {
-  process.stdout.write(data.trim().concat("\n"));
-};
-
-// [function]
-
-const writeErr = function (data) {
-  process.stderr.write(data.trim().concat("\n"));
-};
-
 // [main]
 
-try {
-  if (!file) {
-    throw new Error("No file provided.");
-  }
-  const buf = readFileSync(file, "utf8");
-  const conf = JSON.parse(buf);
-  const version = validSemver(conf?.game?.version);
-  write(
-    version !== null && prereleaseSemver(version) !== null ? "true" : "false",
-  );
-} catch (ex) {
-  writeErr(ex.message);
-  process.exit(1);
-}
+run(() => {
+  const version = validSemver(readManifest(file)?.game?.version);
+  write(version !== null && prereleaseSemver(version) !== null);
+});

package/src/put-version.js

@@ -1,48 +1,33 @@
 "use strict";
+// arctool-put-version <manifest>: the game's version.
 
 // [import]
 
-const fs = require("node:fs");
+const semver = require("semver");
 
 // [import]
 
-const semver = require("semver");
+const io = require("./io");
 
 // [use]
 
-const readFileSync = fs.readFileSync; // eslint-disable-line no-sync
+const fail = io.fail;
+const readManifest = io.readManifest;
+const run = io.run;
 const validSemver = semver.valid;
+const write = io.write;
 
 // [define]
 
 const file = process.argv[2];
 
-// [function]
-
-const write = function (data) {
-  process.stdout.write(data.trim().concat("\n"));
-};
-
-// [function]
-
-const writeErr = function (data) {
-  process.stderr.write(data.trim().concat("\n"));
-};
-
 // [main]
 
-try {
-  if (!file) {
-    throw new Error("No file provided.");
-  }
-  const buf = readFileSync(file, "utf8");
-  const conf = JSON.parse(buf);
-  const version = validSemver(conf?.game?.version);
+run(() => {
+  const value = readManifest(file)?.game?.version;
+  const version = validSemver(value);
   if (version === null) {
-    throw new Error("Invalid semver.");
+    fail(`Invalid version: ${value ?? "not set"}`);
   }
   write(version);
-} catch (ex) {
-  writeErr(ex.message);
-  process.exit(1);
-}
+});