feat: author and committer options (#110)

Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>

.github/workflows/test.yml

@@ -24,7 +24,7 @@ jobs:
           node-version: ${{ matrix.node_version }}
           cache: npm
       - run: npm ci
-      - run: jest --coverage
+      - run: npm test
 
   test:
     runs-on: ubuntu-latest

README.md

@@ -95,6 +95,18 @@ octokit
         },
         commit:
           "creating file1.txt, file2.png, deleting file3.txt, updating file4.txt (if it exists), file5.sh",
+        /* optional: if not passed, will be the authenticated user and the current date */
+        author: {
+          name: "Author LastName",
+          email: "Author.LastName@acme.com",
+          date: new Date().toISOString(), // must be ISO date string
+        },
+        /* optional: if not passed, will use the information set in author */
+        committer: {
+          name: "Committer LastName",
+          email: "Committer.LastName@acme.com",
+          date: new Date().toISOString(), // must be ISO date string
+        },
       },
     ],
   })

src/create-commit.ts

@@ -1,4 +1,4 @@
-import type { Changes, State } from "./types";
+import type { Committer, Changes, State } from "./types";
 
 export async function createCommit(
   state: Required<State>,
@@ -20,6 +20,8 @@ export async function createCommit(
       owner: ownerOrFork,
       repo,
       message,
+      author: changes.author,
+      committer: changes.committer,
       tree: state.latestCommitTreeSha,
       parents: [latestCommitSha],
     }

src/types.ts

@@ -24,6 +24,8 @@ export type Changes = {
   };
   emptyCommit?: boolean | string;
   commit: string;
+  committer?: Committer;
+  author?: Author | undefined;
 };
 
 // https://developer.github.com/v3/git/blobs/#parameters
@@ -58,3 +60,15 @@ export type State = {
   latestCommitTreeSha?: string;
   treeSha?: string;
 };
+
+export type Committer = {
+  name?: string;
+  email?: string;
+  date?: string;
+};
+
+export type Author = {
+  name: string;
+  email: string;
+  date?: string;
+};

test/create-commits-with-author-and-committer.test.ts

@@ -0,0 +1,86 @@
+import { Octokit as Core } from "@octokit/core";
+import { RequestError } from "@octokit/request-error";
+
+import { createPullRequest } from "../src";
+const Octokit = Core.plugin(createPullRequest);
+
+test("author and committer", async () => {
+  const fixtures = require("./fixtures/create-commits-with-author-and-committer");
+  const fixturePr = fixtures[fixtures.length - 1].response;
+  const octokit = new Octokit();
+
+  octokit.hook.wrap("request", (_, options) => {
+    const currentFixtures = fixtures.shift();
+    const {
+      baseUrl,
+      method,
+      url,
+      request,
+      headers,
+      mediaType,
+      draft,
+      ...params
+    } = options;
+
+    expect(
+      `${currentFixtures.request.method} ${currentFixtures.request.url}`
+    ).toEqual(`${options.method} ${options.url}`);
+
+    Object.keys(params).forEach((paramName) => {
+      expect(currentFixtures.request[paramName]).toStrictEqual(
+        params[paramName]
+      );
+    });
+
+    if (currentFixtures.response.status >= 400) {
+      throw new RequestError("Error", currentFixtures.response.status, {
+        request: currentFixtures.request,
+        headers: currentFixtures.response.headers,
+      });
+    }
+
+    return currentFixtures.response;
+  });
+
+  const pr = await octokit.createPullRequest({
+    owner: "gr2m",
+    repo: "sandbox",
+    title: "One comes, one goes",
+    body: "because",
+    head: "test-branch-tv12s",
+    changes: [
+      {
+        files: {
+          "path/to/file1.txt": "Content for file1",
+          "path/to/file2.txt": "Content for file2",
+        },
+        author: {
+          name: "Author LastName",
+          email: "Author.LastName@acme.com",
+          date: "2022-12-06T19:58:39.672Z",
+        },
+        committer: {
+          name: "Committer LastName",
+          email: "Committer.LastName@acme.com",
+          date: "2022-12-06T19:58:39.672Z",
+        },
+        commit: "why",
+      },
+      {
+        files: {
+          "path/to/file1.txt": "New content",
+          "path/to/file4.txt": "Content for file4",
+        },
+        committer: {
+          name: "Committer Smith",
+          email: "Committer.Smith@acme.com",
+          date: "2022-12-06T19:58:39.672Z",
+        },
+        commit: "Make a fix",
+      },
+    ],
+  });
+
+  expect(pr).toStrictEqual(fixturePr);
+  expect(fixtures.length).toEqual(0);
+});