fix: update existing file at a custom branch (#37)

Author: gr2m

src/get-file-content.ts

@@ -9,6 +9,13 @@ type Options = {
   branch?: string;
 };
 
+type GetContentsParameters = {
+  owner: string;
+  repo: string;
+  path: string;
+  ref?: string;
+};
+
 type Result = {
   content: string | null;
   sha?: string;
@@ -36,10 +43,17 @@ export async function getFileContents(
   options: Options
 ): Promise<Result> {
   const route = "GET /repos/{owner}/{repo}/contents/{path}";
-  const requestOptions = octokit.request.endpoint(route, options);
+
+  const { branch, ...parameters } = options;
+  const getContentsParameters: GetContentsParameters = {
+    ...parameters,
+    ref: branch,
+  };
+
+  const requestOptions = octokit.request.endpoint(route, getContentsParameters);
 
   const { data } = await octokit
-    .request(route, options)
+    .request(route, getContentsParameters)
     .catch((error: RequestError) => {
       /* istanbul ignore if */
       if (error.status !== 404) throw error;

test/create-or-update-text-file.test.ts

@@ -289,6 +289,61 @@ describe("README usage examples", () => {
     expect(updated).toEqual(true);
     expect(data).toStrictEqual({ ok: true });
   });
+
+  it("Creates file with static content if file exists at given path and branch", async () => {
+    const mock = fetchMock
+      .sandbox()
+
+      // file exists
+      .getOnce(
+        "https://api.github.com/repos/octocat/hello-world/contents/test.txt?ref=custom-branch",
+        {
+          body: {
+            content: utf8ToBase64("current content"),
+            sha: "sha123",
+            ref: "custom-branch",
+          },
+          status: 200,
+        }
+      )
+
+      // update file
+      .putOnce(
+        "https://api.github.com/repos/octocat/hello-world/contents/test.txt",
+        {
+          body: {
+            ok: true,
+          },
+          status: 200,
+        },
+        {
+          body: {
+            content: utf8ToBase64("content here"),
+            message: "update test.txt",
+            sha: "sha123",
+            branch: "custom-branch",
+          },
+        }
+      );
+
+    const octokit = new MyOctokit({
+      request: {
+        fetch: mock,
+      },
+    });
+
+    const { updated, data } = await octokit.createOrUpdateTextFile({
+      owner: "octocat",
+      repo: "hello-world",
+      path: "test.txt",
+      content: "content here",
+      message: "update test.txt",
+      branch: "custom-branch",
+    });
+
+    expect(updated).toEqual(true);
+    expect(data).toStrictEqual({ ok: true });
+  });
 });
 
 // TODO: add test for browsers