Add an install-fish action.

Author: lgarron

.github/workflows/CI.yaml

@@ -0,0 +1,23 @@
+# This is for testing `actions-workflows` itself.
+
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+      - run: make setup
+      - run: make lint
+
+  fish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: ls /home/runner/work/actions-workflows/actions-workflows/.github/workflows/
+      - uses: ./actions/install-fish
+      - run: fish --version

.gitignore

@@ -0,0 +1 @@
+/node_modules

Makefile

@@ -0,0 +1,24 @@
+.PHONY: lint
+lint: setup
+	bun x -- bun-dx --package @biomejs/biome biome -- check
+	bun x -- bun-dx --package typescript tsc -- --project ./
+
+.PHONY: format
+format: setup
+	bun x -- bun-dx --package @biomejs/biome biome -- check --write
+
+.PHONY: setup
+setup:
+	bun install --frozen-lockfile
+
+.PHONY: install-fish
+install-fish: setup
+	bun run -- ./script/install-fish.ts
+
+.PHONY: clean
+clean:
+	# no-op
+
+.PHONY: reset
+reset: clean
+	rm -rf ./node_modules/

README.md

@@ -1,6 +1,6 @@
 # GitHub Actions workflows
 
-[Reusable GitHub Actions workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows) for https://github.com/cubing projects.
+[Reusable GitHub Actions workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows) for <https://github.com/cubing> projects.
 
 ## Publish GitHub release
 
@@ -27,3 +27,20 @@ jobs:
     uses: cubing/actions-workflows/.github/workflows/publish-github-release.yaml@main
 CONTENTS
 ```
+
+## Install `fish`
+
+Installs `fish` from: <https://github.com/fish-shell/fish-shell/releases>
+
+Because `fish` is already compiled, this is *much* faster than other actions that install from source.
+
+Usage:
+
+```yaml
+    uses: cubing/actions-workflows/actions/install-fish@main
+```
+
+At the moment:
+
+- There is no option to select the `fish` version — a recent version is hardcoded.
+- Only Linux x64 is supported.

actions/install-fish/action.yaml

@@ -0,0 +1,17 @@
+name: Install `fish`
+description: Installs `fish` to `~/.local/share/install-fish/bin/fish`
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install `bun`
+      uses: oven-sh/setup-bun@b7a1c7ccf290d58743029c4f6903da283811b979
+    - name: Add `~/.local/share/install-fish/bin` to `$PATH`
+      shell: bash
+      run: echo "$HOME/.local/share/install-fish/bin" >> "$GITHUB_PATH"
+    - name: PATH
+      shell: bash
+      run: echo "$PATH"
+    - name: Install `fish` to `~/.local/share/install-fish/bin/fish`
+      shell: bash
+      run: bun run ${{ github.action_path }}/install-fish.ts

actions/install-fish/install-fish.ts

@@ -0,0 +1,68 @@
+#!/usr/bin/env -S bun run --
+
+/**
+ * Note: this file does not use any run-time dependencies, only `bun` built-ins.
+ * This is less ergonomic, but it allows running the script directly, which in
+ * turn means fewer opportunities for things to go wrong.
+ */
+
+import assert from "node:assert";
+import { mkdir, mkdtemp, readFile, rename } from "node:fs/promises";
+import { arch, homedir, platform, tmpdir } from "node:os";
+import { dirname, join } from "node:path";
+import { env, exit } from "node:process";
+import { $, write } from "bun";
+
+const BIN_INSTALLATION_DIR = join(
+  homedir(),
+  "./.local/share/install-fish/bin/fish",
+);
+const BIN_INSTALLATION_PATH = join(BIN_INSTALLATION_DIR, "./fish");
+
+console.log("PATH", env["PATH"]);
+
+const metadata: { [version: string]: { url: string; hash: string } } = {
+  "4.3.3": {
+    url: "https://github.com/fish-shell/fish-shell/releases/download/4.3.3/fish-4.3.3-linux-x86_64.tar.xz",
+    hash: "3759c788d7941c5d0ca7713b259612211f4efb9041426ea415aaa8e4022d3392",
+  },
+};
+
+async function installFish(version: string = "4.3.3"): Promise<void> {
+  assert(metadata[version]);
+  const { url, hash } = metadata[version];
+
+  assert.equal(platform(), "linux");
+  assert.equal(arch(), "x64");
+
+  try {
+    await $`fish --version`;
+    console.log("Able to execute `fish`. Skipping installation.");
+    exit(0);
+  } catch {
+    console.log("Unable to execute `fish`. Proceeding with installation.");
+  }
+
+  const tempDir = await mkdtemp(join(tmpdir(), "install-fish-"));
+  const tempArchive = join(tempDir, "./fish.tar.xz");
+  await write(tempArchive, await fetch(url));
+  assert.equal(
+    new Uint8Array(
+      await globalThis.crypto.subtle.digest(
+        "SHA256",
+        // The `new Uint8Array(…)` is not necessary, but it makes the type checker happy.
+        new Uint8Array(await readFile(tempArchive)),
+      ),
+    ).toHex(),
+    hash,
+  );
+
+  await $`cd ${tempDir} && tar -xJvf ${tempArchive}`;
+  await mkdir(dirname(BIN_INSTALLATION_PATH), { recursive: true });
+  await rename(join(tempDir, "fish"), BIN_INSTALLATION_PATH);
+
+  console.log("Installed fish version:");
+  await $`fish --version`;
+}
+
+await installFish();

biome.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "extends": ["./node_modules/@cubing/dev-config/biome/biome.json"],
+  "files": {
+    "includes": ["**", "!!dist"]
+  }
+}

bun.lock

@@ -0,0 +1,3 @@
+[install]
+auto = "disable"
+linker = "isolated"