Allow message to be specified as single string

Author: s0

.changeset/long-rabbits-scream.md

@@ -0,0 +1,5 @@
+---
+"@s0/ghcommit": minor
+---
+
+Allow message to be specified as single string

README.md

@@ -69,7 +69,7 @@ All the functions below accept a single object as its argument, and share the fo
   /**
    * The commit message
    */
-  message: CommitMessage;
+  message: string | CommitMessage;
   log?: Logger;
 }
 ```
@@ -113,9 +113,7 @@ await commitChangesFromRepo({
   octokit,
   ...context.repo,
   branch: "new-branch-to-create",
-  message: {
-    headline: "[chore] do something",
-  },
+  message: "[chore] do something",
 });
 
 // Commit & push the files from a specific directory
@@ -125,9 +123,7 @@ await commitChangesFromRepo({
   owner: "my-org",
   repository: "my-repo",
   branch: "another-new-branch-to-create",
-  message: {
-    headline: "[chore] do something else",
-  },
+  message: "[chore] do something else\n\nsome more details",
   repoDirectory: "/tmp/some-repo",
 });
 
@@ -139,6 +135,7 @@ await commitChangesFromRepo({
   branch: "another-new-branch-to-create",
   message: {
     headline: "[chore] do something else",
+    body: "some more details",
   },
   base: {
     // This will be the original sha from the workflow run,
@@ -192,9 +189,7 @@ await commitFilesFromDirectory({
   octokit,
   ...context.repo,
   branch: "new-branch-to-create",
-  message: {
-    headline: "[chore] do something",
-  },
+  message: "[chore] do something",
   base: {
     branch: "main",
   },
@@ -209,9 +204,7 @@ await commitFilesFromDirectory({
   octokit,
   ...context.repo,
   branch: "docs",
-  message: {
-    headline: "[chore] do something",
-  },
+  message: "[chore] do something",
   force: true, // Overwrite any existing branch
   base: {
     tag: "v1.0.0",
@@ -261,9 +254,7 @@ await commitFilesFromBuffers({
   octokit,
   ...context.repo,
   branch: "new-branch-to-create",
-  message: {
-    headline: "[chore] do something",
-  },
+  message: "[chore] do something",
   base: {
     branch: "main",
   },

src/core.ts

@@ -13,6 +13,7 @@ import {
   CommitFilesResult,
   GitBase,
 } from "./interface.js";
+import { CommitMessage } from "./github/graphql/generated/types.js";
 
 const getBaseRef = (base: GitBase): string => {
   if ("branch" in base) {
@@ -161,14 +162,22 @@ export const commitFilesFromBase64 = async ({
     }
   }
 
+  const finalMessage: CommitMessage =
+    typeof message === "string"
+      ? {
+          headline: message.split("\n")[0]?.trim() ?? "",
+          body: message.split("\n").slice(1).join("\n").trim(),
+        }
+      : message;
+
   await log?.debug(`Creating commit on branch ${branch}`);
   const createCommitMutation: CreateCommitOnBranchMutationVariables = {
     input: {
       branch: {
         id: refId,
       },
       expectedHeadOid: baseOid,
-      message,
+      message: finalMessage,
       fileChanges,
     },
   };

src/github/graphql/queries.ts

@@ -105,6 +105,7 @@ const GET_REF_TREE = /* GraphQL */ `
                 oid
               }
             }
+            message
             file(path: $path) {
               oid
             }

src/interface.ts

@@ -36,7 +36,7 @@ export interface CommitFilesBasedArgs {
   /**
    * The commit message
    */
-  message: CommitMessage;
+  message: string | CommitMessage;
   log?: Logger;
 }
 

src/test/integration/node.test.ts

@@ -9,6 +9,7 @@ import {
   getRefTreeQuery,
   getRepositoryMetadata,
 } from "../../github/graphql/queries.js";
+import { CommitMessage } from "../../github/graphql/generated/types.js";
 import git from "isomorphic-git";
 
 // TODO: re-enable strict tree tests when GitHub have addressed the createRef
@@ -391,6 +392,67 @@ describe("node", () => {
         });
       });
     });
+
+    describe("commit message is correctly handled", () => {
+      const testCommitMessage = async ({
+        branch,
+        input,
+        expected,
+      }: {
+        branch: string;
+        input: string | CommitMessage;
+        expected: string;
+      }) => {
+        await commitFilesFromBuffers({
+          octokit,
+          ...REPO,
+          branch,
+          base: {
+            commit: testTargetCommit,
+          },
+          ...BASIC_FILE_CONTENTS,
+          message: input,
+        });
+
+        const ref = (
+          await getRefTreeQuery(octokit, {
+            ...REPO,
+            ref: `refs/heads/${branch}`,
+            path: "package.json",
+          })
+        ).repository?.ref?.target;
+
+        if (!ref || !("message" in ref)) {
+          throw new Error("Unexpected result");
+        }
+
+        expect(ref.message).toEqual(expected);
+      };
+
+      it("single string", async () => {
+        const branch = `${TEST_BRANCH_PREFIX}-commit-message-single`;
+        branches.push(branch);
+
+        await testCommitMessage({
+          branch,
+          input: "This is a basic commit message",
+          expected: "This is a basic commit message!",
+        });
+      });
+
+      it("multi-line string", async () => {
+        const branch = `${TEST_BRANCH_PREFIX}-commit-message-multi`;
+        branches.push(branch);
+
+        await testCommitMessage({
+          branch,
+          input:
+            "This is a basic commit message\nwith a second line\n\nand some more lines!",
+          expected:
+            "This is a basic commit message\nwith a second line\n\nand some more lines!",
+        });
+      });
+    });
   });
 
   afterAll(async () => {