@arcadible/github-release-tools 0.1.29 → 0.1.32

package/README.md

@@ -1,3 +1,38 @@
-# GitHub Release Tools
+<p align="center">
+  <a href="https://arcadible.com">
+    <img src="https://adn-arcadible.imgix.net/images/i18n/core/www/appicon-512.png?w=256" alt="Arcadible" height="96">
+  </a>
+</p>
 
-Provides helper commands for the `Arcadible Release` workflow on GitHub Actions.
+<h1 align="center">Arcadible GitHub Release Tools</h1>
+
+<p align="center">
+  Helper commands for the Arcadible Release workflow on GitHub Actions.
+</p>
+
+<p align="center">
+  <a href="https://developer.arcadible.com/guides/publishing/deploying-from-github">Docs</a> ·
+  <a href="https://www.npmjs.com/package/arcadible">Arcadible CLI</a> ·
+  <a href="https://arcadible.com">Arcadible</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.
+
+| 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 |
+
+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.
+
+## License
+
+Apache-2.0

package/bin/arctool-install-deps.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+SCRIPT="$(realpath "$0")"
+DIR="$(dirname "$SCRIPT")"
+node "$DIR/../src/install-deps.js" "$1"

package/package.json

@@ -1,7 +1,9 @@
 {
+  "author": "Offst, Inc.",
   "bin": {
     "arctool-assert-dir": "bin/arctool-assert-dir.sh",
     "arctool-assert-tag": "bin/arctool-assert-tag.sh",
+    "arctool-install-deps": "bin/arctool-install-deps.sh",
     "arctool-put-build": "bin/arctool-put-build.sh",
     "arctool-put-cache": "bin/arctool-put-cache.sh",
     "arctool-put-deploy-dir": "bin/arctool-put-deploy-dir.sh",
@@ -11,11 +13,24 @@
   "dependencies": {
     "semver": "^7.7.3"
   },
-  "description": "Provides helper commands used by the Arcadible Release workflow on GitHub.",
+  "description": "Helper commands for the Arcadible Release workflow on GitHub Actions.",
   "engines": {
-    "node": ">=24.11.1"
+    "node": ">=24"
   },
+  "files": [
+    "bin",
+    "src"
+  ],
+  "homepage": "https://developer.arcadible.com/guides/publishing/deploying-from-github",
+  "keywords": [
+    "arcadible",
+    "github-actions",
+    "release"
+  ],
   "license": "Apache-2.0",
   "name": "@arcadible/github-release-tools",
-  "version": "0.1.29"
+  "scripts": {
+    "test": "node --test \"test/**/*.test.js\""
+  },
+  "version": "0.1.32"
 }

package/src/install-deps.js

@@ -0,0 +1,60 @@
+"use strict";
+
+// [import]
+
+const cp = require("node:child_process");
+
+// [import]
+
+const detect = require("./lockfile");
+
+// [use]
+
+const spawnSync = cp.spawnSync; // eslint-disable-line no-sync
+
+// [declare]
+
+// the install that follows the lockfile exactly, for each package manager.
+// pnpm and yarn run through corepack, which ships with Node.js 24 and uses the
+// version a project's packageManager names.
+const COMMANDS = {
+  npm: ["npm", ["ci"]],
+  pnpm: ["corepack", ["pnpm", "install", "--frozen-lockfile"]],
+  yarn: ["corepack", ["yarn", "install", "--frozen-lockfile"]],
+};
+
+// [define]
+
+const dir = process.argv[2];
+
+// [function]
+
+const writeErr = function (data) {
+  process.stderr.write(data.trim().concat("\n"));
+};
+
+// [main]
+
+try {
+  if (!dir) {
+    throw new Error("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);
+    }
+  }
+} catch (ex) {
+  writeErr(ex.message);
+  process.exit(1);
+}

package/src/lockfile.js

@@ -0,0 +1,35 @@
+"use strict";
+
+// [import]
+
+const fs = require("node:fs");
+const path = require("node:path");
+
+// [use]
+
+const existsSync = fs.existsSync; // eslint-disable-line no-sync
+const join = path.join;
+
+// [declare]
+
+// each package manager, and the lockfiles that mean a project uses it, in the
+// order they're checked.
+const LOCKFILES = [
+  ["npm", ["package-lock.json", "npm-shrinkwrap.json"]],
+  ["pnpm", ["pnpm-lock.yaml"]],
+  ["yarn", ["yarn.lock"]],
+];
+
+// [function]
+
+// the package manager a project's lockfile names, or "" when it has none.
+const detect = function (root) {
+  const found = LOCKFILES.find(([, names]) =>
+    names.some((name) => existsSync(join(root, name))),
+  );
+  return found ? found[0] : "";
+};
+
+// [export]
+
+module.exports = detect;

package/src/put-cache.js

@@ -2,14 +2,15 @@
 
 // [import]
 
-const fs = require("node:fs");
 const path = require("node:path");
 
+// [import]
+
+const detect = require("./lockfile");
+
 // [use]
 
 const dirname = path.dirname;
-const existsSync = fs.existsSync; // eslint-disable-line no-sync
-const join = path.join;
 
 // [define]
 
@@ -33,19 +34,7 @@ try {
   if (!file) {
     throw new Error("No file provided.");
   }
-  const root = dirname(file);
-  if (
-    existsSync(join(root, "package-lock.json")) ||
-    existsSync(join(root, "npm-shrinkwrap.json"))
-  ) {
-    write("npm");
-  } else if (existsSync(join(root, "pnpm-lock.yaml"))) {
-    write("pnpm");
-  } else if (existsSync(join(root, "yarn.lock"))) {
-    write("yarn");
-  } else {
-    write("");
-  }
+  write(detect(dirname(file)));
 } catch (ex) {
   writeErr(ex.message);
   process.exit(1);

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-  "extends": "eslint-config-offst"
-}