Merge branch 'initialize-git-notes'

Author: dscho

initialize-git-notes/action.yml

@@ -0,0 +1,20 @@
+name: 'Initialize the Git notes'
+description: 'Creates initial, mostly empty Git notes for GitGitGadget to store its state in.'
+author: 'Johannes Schindelin'
+inputs:
+  config:
+    description: 'The GitGitGadget configuration to use (see https://github.com/gitgitgadget/gitgitgadget/blob/HEAD/lib/project-config.ts)'
+    default: '' # sadly, ${{ vars.CONFIG }} does not work, and documentation about what contexts are permissible here is sorely missing
+  pr-repo-token:
+    description: 'The access token to work on the repository that holds PRs and state'
+    required: true
+  initial-user:
+    description: 'The user that is initially the only one allowed to use GitGitGadget in the given project'
+    default: ${{ github.actor }}
+    required: true
+runs:
+  using: 'node20'
+  main: './index.js'
+branding:
+  icon: 'git-commit'
+  color: 'orange'

initialize-git-notes/index.js

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

lib/ci-helper.ts

@@ -103,6 +103,7 @@ export class CIHelper {
         needsUpstreamBranches?: boolean;
         needsMailToCommitNotes?: boolean;
         createOrUpdateCheckRun?: boolean | "post";
+        createGitNotes?: boolean;
     }): Promise<void> {
         // configure the Git committer information
         process.env.GIT_CONFIG_PARAMETERS = [
@@ -136,6 +137,9 @@ export class CIHelper {
         }
 
         if (setupOptions?.createOrUpdateCheckRun) {
+            if (setupOptions?.createGitNotes) {
+                throw new Error(`Cannot use createOrUpdateCheckRun and createGitNotes at the same time`);
+            }
             return await this.createOrUpdateCheckRun(setupOptions.createOrUpdateCheckRun === "post");
         }
 
@@ -169,6 +173,47 @@ export class CIHelper {
         ]) {
             await git(["config", key, value], { workDir: this.workDir });
         }
+        if (setupOptions?.createGitNotes) {
+            if (
+                setupOptions.needsMailToCommitNotes ||
+                setupOptions.needsUpstreamBranches ||
+                setupOptions.needsMailingListMirror
+            ) {
+                throw new Error("`createGitNotes` cannot be combined with any other options");
+            }
+            const initialUser = core.getInput("initial-user");
+            console.time("verify that Git notes do not yet exist");
+            const existingNotes = await git(
+                [
+                    "ls-remote",
+                    "origin",
+                    GitNotes.defaultNotesRef,
+                    "refs/notes/mail-to-commit",
+                    "refs/notes/commit-to-mail",
+                ],
+                {
+                    workDir: this.workDir,
+                },
+            );
+            if (existingNotes !== "") {
+                throw new Error(`Git notes already exist in ${this.workDir}:\n${existingNotes}`);
+            }
+            console.timeEnd("verify that Git notes do not yet exist");
+            console.time("create the initial Git notes and push them");
+            for (const key of ["mail-to-commit", "commit-to-mail"]) {
+                const notes = new GitNotes(this.workDir, `refs/notes/${key}`);
+                await notes.initializeWithEmptyCommit();
+                await notes.push(this.urlRepo, this.notesPushToken);
+            }
+            const options: IGitGitGadgetOptions = {
+                allowedUsers: [initialUser],
+            };
+            await this.notes.set("", options, true);
+            await this.notes.push(this.urlRepo, this.notesPushToken);
+            console.timeEnd("create the initial Git notes and push them");
+            return;
+        }
+
         console.time("fetch Git notes");
         const notesRefs = [GitNotes.defaultNotesRef];
         if (setupOptions?.needsMailToCommitNotes) {

lib/git-notes.ts

@@ -120,6 +120,14 @@ export class GitNotes {
         return notes.replace(/^[^]*\n\n/, "");
     }
 
+    public async initializeWithEmptyCommit(): Promise<void> {
+        const emptyTree = await git(["hash-object", "-t", "tree", "--stdin"], { stdin: "", workDir: this.workDir });
+        const emptyCommit = await git(["commit-tree", "-m", "Initial empty commit", emptyTree], {
+            workDir: this.workDir,
+        });
+        await git(["update-ref", this.notesRef, emptyCommit, ""], { workDir: this.workDir });
+    }
+
     public async update(url: string): Promise<void> {
         if (this.notesRef.match(/^refs\/notes\/(gitgitgadget|commit-to-mail|mail-to-commit)$/)) {
             await git(["fetch", "--no-tags", url, `+${this.notesRef}:${this.notesRef}`], { workDir: this.workDir });

lib/mail-archive-helper.ts

@@ -269,7 +269,7 @@ export class MailArchiveGitHelper {
             throw new Error(
                 [
                     "Mail archive email commit tip not set.  ",
-                    "Please run `misc-helper init-email-commit-tip` to set the value.",
+                    "Please run the `initialize-git-notes` workflow to set the value.",
                 ].join(""),
             );
         }