feat: add 'local-actions' action

Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>

Author: neilime

Makefile

@@ -31,7 +31,7 @@ test: ## Execute tests
 
 ci: ## Execute CI tasks
 	$(MAKE) setup
-	$(MAKE) npm-audit-fix
+	$(MAKE) npm-audit-fix || true
 	$(MAKE) lint-fix
 	$(MAKE) test
 

README.md

@@ -29,6 +29,7 @@ Opinionated GitHub Actions and reusable workflows for foundational continuous-in
 ### Matrix & workflow data helpers
 
 - [Get matrix outputs](actions/get-matrix-outputs/README.md) - aggregates outputs across matrix jobs for downstream steps.
+- [Local actions](actions/local-actions/README.md) - exposes sibling local actions for a composite action and cleans them up automatically.
 - [Set matrix output](actions/set-matrix-output/README.md) - writes structured outputs that can be consumed by other matrix jobs.
 - [Local workflow actions](actions/local-workflow-actions/README.md) - loads reusable workflow actions from the current repository.
 

actions/create-and-merge-pull-request/action.yml

@@ -32,17 +32,12 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - shell: bash
-      # FIXME: workaround until will be merged: https://github.com/actions/runner/pull/1684
-      run: mkdir -p ./self-actions/ && cp -r $GITHUB_ACTION_PATH/../* ./self-actions/
+    - uses: ./../local-actions
+      with:
+        source-path: ${{ github.action_path }}
 
     - id: github-actions-bot-user
-      uses: ./self-actions/get-github-actions-bot-user
-
-    - shell: bash
-      # FIXME: workaround until will be merged: https://github.com/actions/runner/pull/1684
-      run: |
-        rm -fr ./self-actions
+      uses: ./../self-actions/get-github-actions-bot-user
 
     - uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
       id: create-pull-request

actions/create-or-update-comment/action.yml

@@ -34,18 +34,12 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - shell: bash
-      # FIXME: workaround until will be merged: https://github.com/actions/runner/pull/1684
-      run: |
-        [ -d ./self-actions ] || (mkdir -p ./self-actions/ && cp -r $GITHUB_ACTION_PATH/../* ./self-actions/)
+    - uses: ./../local-actions
+      with:
+        source-path: ${{ github.action_path }}
 
     - id: get-issue-number
-      uses: ./self-actions/get-issue-number
-
-    - shell: bash
-      # FIXME: workaround until will be merged: https://github.com/actions/runner/pull/1684
-      run: |
-        rm -fr ./self-actions
+      uses: ./../self-actions/get-issue-number
 
     - uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad # v4.0.0
       id: find-comment

actions/local-actions/ActionRuntime.js

@@ -0,0 +1,52 @@
+import { appendFile } from "node:fs/promises";
+import process from "node:process";
+import { randomUUID } from "node:crypto";
+
+export class ActionRuntime {
+  getInput(name, { required = false } = {}) {
+    const value =
+      process.env[`INPUT_${name.replaceAll(" ", "_").toUpperCase()}`] ?? "";
+
+    if (required && value.trim() === "") {
+      throw new Error(`Input required and not supplied: ${name}`);
+    }
+
+    return value;
+  }
+
+  async setOutput(name, value) {
+    await this.#writeCommandFile(process.env.GITHUB_OUTPUT, name, value);
+  }
+
+  async saveState(name, value) {
+    await this.#writeCommandFile(process.env.GITHUB_STATE, name, value);
+  }
+
+  getState(name) {
+    return process.env[`STATE_${name}`] ?? "";
+  }
+
+  info(message) {
+    console.log(message);
+  }
+
+  setFailed(error) {
+    const message = error instanceof Error ? error.message : String(error);
+    console.error(`::error::${message}`);
+    process.exitCode = 1;
+  }
+
+  async #writeCommandFile(filePath, name, value) {
+    if (!filePath) {
+      throw new Error(`Missing command file for ${name}.`);
+    }
+
+    const stringValue = String(value);
+    const delimiter = `ghadelimiter_${randomUUID()}`;
+    await appendFile(
+      filePath,
+      `${name}<<${delimiter}\n${stringValue}\n${delimiter}\n`,
+      "utf8",
+    );
+  }
+}

actions/local-actions/LocalActionsManager.js

@@ -0,0 +1,96 @@
+import { access, cp, mkdir, readdir, rm, stat } from "node:fs/promises";
+import path from "node:path";
+
+export class LocalActionsManager {
+  async prepare({ sourcePath, destination }) {
+    const actionPath = await this.#resolveActionPath(sourcePath);
+    const sourceDirectory = path.dirname(actionPath);
+    const destinationPath = this.resolveDestinationPath({
+      actionPath,
+      destination,
+    });
+
+    if (await this.#exists(destinationPath)) {
+      return {
+        created: false,
+        destinationPath,
+      };
+    }
+
+    const entryNames = await readdir(sourceDirectory);
+    await mkdir(destinationPath, { recursive: true });
+
+    for (const entryName of entryNames) {
+      const sourceEntryPath = path.join(sourceDirectory, entryName);
+      if (sourceEntryPath === destinationPath) {
+        continue;
+      }
+
+      await cp(sourceEntryPath, path.join(destinationPath, entryName), {
+        recursive: true,
+      });
+    }
+
+    return {
+      created: true,
+      destinationPath,
+    };
+  }
+
+  async cleanup({ created, destinationPath }) {
+    if (!created || !destinationPath) {
+      return false;
+    }
+
+    await rm(destinationPath, { force: true, recursive: true });
+    return true;
+  }
+
+  resolveDestinationPath({ actionPath, destination }) {
+    if (!destination?.trim()) {
+      throw new Error("Input destination is required.");
+    }
+
+    const destinationPath = path.resolve(actionPath, destination);
+    const sourceDirectory = path.dirname(actionPath);
+    if (destinationPath === sourceDirectory) {
+      throw new Error(
+        "Destination path must not be the source actions directory.",
+      );
+    }
+
+    if (destinationPath === actionPath) {
+      throw new Error(
+        "Destination path must not be the current action directory.",
+      );
+    }
+
+    return destinationPath;
+  }
+
+  async #resolveActionPath(sourcePath) {
+    if (!sourcePath?.trim()) {
+      throw new Error("Input source-path is required.");
+    }
+
+    const actionPath = path.resolve(sourcePath);
+    if (!(await this.#exists(actionPath))) {
+      throw new Error(`Action path does not exist: ${actionPath}`);
+    }
+
+    if (!(await stat(actionPath)).isDirectory()) {
+      throw new Error(`Action path must be a directory: ${actionPath}`);
+    }
+
+    return actionPath;
+  }
+
+  async #exists(targetPath) {
+    try {
+      await access(targetPath);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+}

actions/local-actions/LocalActionsManager.test.js

@@ -0,0 +1,142 @@
+import {
+  existsSync,
+  mkdtempSync,
+  mkdirSync,
+  readFileSync,
+  rmSync,
+  writeFileSync,
+} from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import test from "node:test";
+import assert from "node:assert/strict";
+
+import { LocalActionsManager } from "./LocalActionsManager.js";
+
+const createFixture = () => {
+  const rootDirectory = mkdtempSync(path.join(os.tmpdir(), "local-actions-"));
+  const actionsDirectory = path.join(rootDirectory, "actions");
+  const currentActionPath = path.join(
+    actionsDirectory,
+    "create-or-update-comment",
+  );
+  const siblingActionPath = path.join(actionsDirectory, "get-issue-number");
+
+  mkdirSync(currentActionPath, { recursive: true });
+  mkdirSync(siblingActionPath, { recursive: true });
+  writeFileSync(
+    path.join(currentActionPath, "action.yml"),
+    "name: current\n",
+    "utf8",
+  );
+  writeFileSync(
+    path.join(siblingActionPath, "action.yml"),
+    "name: sibling\n",
+    "utf8",
+  );
+
+  return {
+    actionsDirectory,
+    currentActionPath,
+    rootDirectory,
+    selfActionsPath: path.join(actionsDirectory, "self-actions"),
+    teardown() {
+      rmSync(rootDirectory, { force: true, recursive: true });
+    },
+  };
+};
+
+test("prepare copies sibling actions into the destination directory", async () => {
+  const fixture = createFixture();
+  const manager = new LocalActionsManager();
+
+  try {
+    const result = await manager.prepare({
+      destination: "../self-actions",
+      sourcePath: fixture.currentActionPath,
+    });
+
+    assert.equal(result.created, true);
+    assert.equal(result.destinationPath, fixture.selfActionsPath);
+    assert.equal(
+      readFileSync(
+        path.join(fixture.selfActionsPath, "get-issue-number", "action.yml"),
+        "utf8",
+      ),
+      "name: sibling\n",
+    );
+    assert.equal(
+      readFileSync(
+        path.join(
+          fixture.selfActionsPath,
+          "create-or-update-comment",
+          "action.yml",
+        ),
+        "utf8",
+      ),
+      "name: current\n",
+    );
+    assert.equal(
+      existsSync(path.join(fixture.selfActionsPath, "self-actions")),
+      false,
+    );
+  } finally {
+    fixture.teardown();
+  }
+});
+
+test("prepare reuses an existing destination without marking it for cleanup", async () => {
+  const fixture = createFixture();
+  const manager = new LocalActionsManager();
+
+  try {
+    mkdirSync(fixture.selfActionsPath, { recursive: true });
+    writeFileSync(
+      path.join(fixture.selfActionsPath, "marker.txt"),
+      "existing\n",
+      "utf8",
+    );
+
+    const result = await manager.prepare({
+      destination: "../self-actions",
+      sourcePath: fixture.currentActionPath,
+    });
+
+    assert.equal(result.created, false);
+    assert.equal(
+      readFileSync(path.join(fixture.selfActionsPath, "marker.txt"), "utf8"),
+      "existing\n",
+    );
+  } finally {
+    fixture.teardown();
+  }
+});
+
+test("cleanup removes the destination only when it was created by the action", async () => {
+  const fixture = createFixture();
+  const manager = new LocalActionsManager();
+
+  try {
+    await manager.prepare({
+      destination: "../self-actions",
+      sourcePath: fixture.currentActionPath,
+    });
+
+    assert.equal(
+      await manager.cleanup({
+        created: true,
+        destinationPath: fixture.selfActionsPath,
+      }),
+      true,
+    );
+    assert.equal(
+      await manager.cleanup({
+        created: false,
+        destinationPath: fixture.selfActionsPath,
+      }),
+      false,
+    );
+  } finally {
+    fixture.teardown();
+  }
+});

actions/local-actions/README.md

@@ -0,0 +1,40 @@
+<!-- header:start -->
+
+# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItY29weSIgY29sb3I9ImJsdWUiPjxyZWN0IHg9IjkiIHk9IjkiIHdpZHRoPSIxMyIgaGVpZ2h0PSIxMyIgcng9IjIiIHJ5PSIyIj48L3JlY3Q+PHBhdGggZD0iTTUgMTVIM2EyIDIgMCAwIDEtMi0yVjNhMiAyIDAgMCAxIDItMmgxMGEyIDIgMCAwIDEgMiAydjIiPjwvcGF0aD48L3N2Zz4=) GitHub Action: Local actions
+
+<div align="center">
+  <img src="../../.github/logo.svg" width="60px" align="center" alt="Local actions" />
+</div>
+
+---
+
+<!-- header:end -->
+
+## Overview
+
+Action to expose sibling local actions next to the current action directory.
+It copies the parent actions directory into a configurable destination during the main step and removes it automatically in the post step.
+
+## Usage
+
+```yaml
+- uses: ./../local-actions
+  with:
+    source-path: ${{ github.action_path }}
+    destination: ../self-actions
+
+- uses: ./../self-actions/get-issue-number
+```
+
+## Inputs
+
+| **Input**         | **Description**                                                             | **Required** | **Default**       |
+| ----------------- | --------------------------------------------------------------------------- | ------------ | ----------------- |
+| **`source-path`** | The current action path. Pass `${{ github.action_path }}` from the caller.  | **true**     | -                 |
+| **`destination`** | Destination path for the copied local actions, resolved from `source-path`. | **false**    | `../self-actions` |
+
+## Outputs
+
+| **Output** | **Description**                                        |
+| ---------- | ------------------------------------------------------ |
+| **`path`** | The destination path input used for the copied actions |