Merge branch 'add-the-action'

Author: dscho

.gitignore

@@ -2,6 +2,7 @@
 /.env
 /.test-dir/
 /build/
+/dist/**/*.d.ts
 /node_modules/
 /npm-debug.log
 /junit.xml
@@ -10,4 +11,3 @@
 /obj/**
 /*.sln*
 /*.njsproj*
-/*.tgz

eslint.config.mjs

@@ -1,11 +1,11 @@
-import eslint from "@eslint/js";
-import stylistic from "@stylistic/eslint-plugin";
-import jsdoc from "eslint-plugin-jsdoc";
-import eslintConfigPrettier from "eslint-config-prettier";
-import eslintPluginPrettier from "eslint-plugin-prettier";
-import eslintPluginSecurity from "eslint-plugin-security";
-import globals from "globals";
-import tseslint from "typescript-eslint";
+import eslint from "@eslint/js"
+import stylistic from "@stylistic/eslint-plugin"
+import jsdoc from "eslint-plugin-jsdoc"
+import eslintConfigPrettier from "eslint-config-prettier"
+import eslintPluginPrettier from "eslint-plugin-prettier"
+import eslintPluginSecurity from "eslint-plugin-security"
+import globals from "globals"
+import tseslint from "typescript-eslint"
 
 export default tseslint.config(
   {
@@ -127,6 +127,18 @@ export default tseslint.config(
       "security/detect-object-injection": "off",
     },
   },
+  {
+    files: ["**/*.js", "**/*.mjs"],
+    rules: {
+      "@stylistic/semi": ["error", "never"],
+      "prettier/prettier": [
+        "warn",
+        {
+          semi: false,
+        },
+      ],
+    },
+  },
   {
     files: ["tests/*.ts", "lib/*.ts", "script/*.ts"],
     extends: [...tseslint.configs.recommendedTypeChecked],
@@ -181,4 +193,4 @@ export default tseslint.config(
     },
   },
   // eslintPluginPrettierRecommended,
-);
+)

handle-pr-comment/action.yml

@@ -0,0 +1,25 @@
+name: 'Handle PR Comment'
+description: 'Handles slash commands such as /submit and /preview'
+author: 'Johannes Schindelin'
+inputs:
+  gitgitgadget-git-access-token:
+    description: 'The access token to work on gitgitgadget/git'
+    required: true
+  git-git-access-token:
+    description: 'The access token to work on git/git'
+    required: true
+  dscho-git-access-token:
+    description: 'The access token to work on dscho/git'
+    required: true
+  smtp-options:
+    description: 'The SMTP options to use for sending emails'
+    required: true
+  pr-comment-url:
+    description: 'The URL of the PR comment to add a reaction to'
+    required: true
+runs:
+  using: 'node20'
+  main: './index.js'
+branding:
+  icon: 'git-commit'
+  color: 'orange'

handle-pr-comment/index.js

@@ -0,0 +1,11 @@
+async function run() {
+  const { CIHelper } = await import("../dist/index.js")
+
+  const ci = new CIHelper()
+  const { owner, commentId } = ci.parsePRCommentURLInput()
+
+  await ci.setupGitHubAction()
+  await ci.handleComment(owner, commentId)
+}
+
+run()

lib/ci-helper.ts

@@ -1,6 +1,8 @@
+import * as core from "@actions/core";
 import * as fs from "fs";
 import * as util from "util";
 import addressparser from "nodemailer/lib/addressparser/index.js";
+import path from "path";
 import { ILintError, LintCommit } from "./commit-lint.js";
 import { commitExists, git, emptyTreeName } from "./git.js";
 import { GitNotes } from "./git-notes.js";
@@ -15,6 +17,7 @@ import { IPatchSeriesMetadata } from "./patch-series-metadata.js";
 import { IConfig, getExternalConfig, setConfig } from "./project-config.js";
 import { getPullRequestKeyFromURL, pullRequestKey } from "./pullRequestKey.js";
 import { ISMTPOptions } from "./send-mail.js";
+import { fileURLToPath } from "url";
 
 const readFile = util.promisify(fs.readFile);
 type CommentFunction = (comment: string) => Promise<void>;
@@ -62,6 +65,84 @@ export class CIHelper {
         this.urlRepo = `${this.urlBase}${this.config.repo.name}/`;
     }
 
+    public async setupGitHubAction(): Promise<void> {
+        // help dugite realize where `git` is...
+        process.env.LOCAL_GIT_DIRECTORY = "/usr/";
+        process.env.GIT_EXEC_PATH = "/usr/lib/git-core";
+
+        // get the access tokens via the inputs of the GitHub Action
+        this.setAccessToken("gitgitgadget", core.getInput("gitgitgadget-git-access-token"));
+        this.setAccessToken("git", core.getInput("git-git-access-token"));
+        this.setAccessToken("dscho", core.getInput("dscho-git-access-token"));
+
+        // set the SMTP options
+        try {
+            const options = JSON.parse(core.getInput("smtp-options")) as {
+                user?: string;
+                host?: string;
+                pass?: string;
+                opts?: string;
+            };
+            if (typeof options === "object" && options.user && options.host && options.pass) {
+                this.setSMTPOptions({
+                    smtpUser: options.user,
+                    smtpHost: options.host,
+                    smtpPass: options.pass,
+                    smtpOpts: options.opts,
+                });
+            }
+        } catch (e) {
+            // Ignore, for now
+        }
+
+        // eslint-disable-next-line security/detect-non-literal-fs-filename
+        if (!fs.existsSync(this.workDir)) await git(["init", "--bare", "--initial-branch", "main", this.workDir]);
+        for (const [key, value] of [
+            ["remote.origin.url", `https://github.com/${this.config.repo.owner}/${this.config.repo.name}`],
+            ["remote.origin.promisor", "true"],
+            ["remote.origin.partialclonefilter", "blob:none"],
+        ]) {
+            await git(["config", key, value], { workDir: this.workDir });
+        }
+        const notesRefs = [GitNotes.defaultNotesRef];
+        // TODO Add `refs/notes/mail-to-commit` on demand
+        await git(
+            [
+                "-c",
+                "remote.origin.promisor=false", // let's fetch the notes with all of their blobs
+                "fetch",
+                "origin",
+                "--depth=1",
+                ...notesRefs.map((ref) => `+${ref}:${ref}`),
+            ],
+            {
+                workDir: this.workDir,
+            },
+        );
+        this.gggNotesUpdated = true;
+        // TODO: determine on demand how many commits to fetch; This is contingent on the need
+        // to fetch a PR branch (for handle-pr-push or handle-pr-comment), or whether the upstream branches
+        // are needed (for update-commit-mappings and handle-open-prs).
+        // await git(["fetch", "origin", "--depth=500", `${GitNotes.defaultNotesRef}:${GitNotes.defaultNotesRef}`], {
+        //     workDir: this.workDir,
+        // });
+        // "Un-shallow" the refs without fetching anything; Since this is a partial clone,
+        // any missing commits will be fetched on demand (but when fetching a commit, you
+        // get the entire commit history reachable from it, too, that's why we go through
+        // the stunt of making a shallow-not-shallow fetch here).
+        await fs.promises.rm(path.join(this.workDir, ".git", "shallow"), { force: true });
+    }
+
+    public parsePRCommentURLInput(): { owner: string; repo: string; prNumber: number; commentId: number } {
+        const prCommentUrl = core.getInput("pr-comment-url");
+        const [, owner, repo, prNumber, commentId] =
+            prCommentUrl.match(/^https:\/\/github\.com\/([^/]+)\/([^/]+)\/pull\/(\d+)#issuecomment-(\d+)/) || [];
+        if (!this.config.repo.owners.includes(owner) || repo !== "git") {
+            throw new Error(`Invalid PR comment URL: ${prCommentUrl}`);
+        }
+        return { owner, repo, prNumber: parseInt(prNumber, 10), commentId: parseInt(commentId, 10) };
+    }
+
     public setAccessToken(repositoryOwner: string, token: string): void {
         this.github.setAccessToken(repositoryOwner, token);
         if (this.config.repo.owner === repositoryOwner) {
@@ -73,6 +154,10 @@ export class CIHelper {
         this.smtpOptions = smtpOptions;
     }
 
+    public static getActionsCore(): typeof import("@actions/core") {
+        return core;
+    }
+
     /*
      * Given a commit that was contributed as a patch via GitGitGadget (i.e.
      * a commit with a Message-ID recorded in `refs/notes/gitgitgadget`),
@@ -785,6 +870,11 @@ export class CIHelper {
         }
     }
 
+    public static async getWelcomeMessage(username: string): Promise<string> {
+        const resPath = path.resolve(fileURLToPath(new URL(".", import.meta.url)), "..", "res", "WELCOME.md");
+        return (await readFile(resPath)).toString().replace(/\${username}/g, username);
+    }
+
     public async handlePush(repositoryOwner: string, prNumber: number): Promise<void> {
         const prKey = {
             owner: repositoryOwner,
@@ -808,7 +898,7 @@ export class CIHelper {
             this.smtpOptions,
         );
         if (!pr.hasComments && !gitGitGadget.isUserAllowed(pr.author)) {
-            const welcome = (await readFile("res/WELCOME.md")).toString().replace(/\${username}/g, pr.author);
+            const welcome = await CIHelper.getWelcomeMessage(pr.author);
             await this.github.addPRComment(prKey, welcome);
 
             await this.github.addPRLabels(prKey, ["new user"]);