fetch gh-pages branch using github token

Source: benchmark-action/github-action-benchmark#38

Author: leoholz

src/git.ts

@@ -85,3 +85,15 @@ export async function pull(token: string | undefined, branch: string, ...options
 
     return cmd(...args);
 }
+
+export async function fetch(token: string | undefined, branch: string, ...options: string[]): Promise<string> {
+    core.debug(`Executing 'git fetch' for branch '${branch}' with token and options '${options.join(' ')}'`);
+
+    const remote = token !== undefined ? getRemoteUrl(token) : 'origin';
+    let args = ['fetch', remote, `${branch}:${branch}`];
+    if (options.length > 0) {
+        args = args.concat(options);
+    }
+
+    return cmd(...args);
+}

src/write.ts

@@ -428,9 +428,9 @@ async function writeBenchmarkToGitHubPagesWithRetry(
 }
 
 async function writeBenchmarkToGitHubPages(bench: Benchmark, config: Config): Promise<Benchmark | null> {
-    const { ghPagesBranch, skipFetchGhPages } = config;
+    const { ghPagesBranch, skipFetchGhPages, githubToken } = config;
     if (!skipFetchGhPages) {
-        await git.cmd('fetch', 'origin', `${ghPagesBranch}:${ghPagesBranch}`);
+        await git.fetch(githubToken, ghPagesBranch);
     }
     await git.cmd('switch', ghPagesBranch);
     try {

test/git.ts

@@ -76,7 +76,7 @@ mock('@actions/github', {
     context: gitHubContext,
 });
 
-const { cmd, pull, push } = require('../src/git');
+const { cmd, pull, push, fetch } = require('../src/git');
 const ok: (x: any) => asserts x = A.ok;
 const userArgs = [
     '-c',
@@ -209,4 +209,48 @@ describe('git', function () {
             eq(fakedExec.lastArgs, null);
         });
     });
+
+    describe('fetch()', function () {
+        afterEach(function () {
+            gitHubContext.payload.repository = { full_name: 'user/repo' };
+        });
+
+        it('runs `git fetch` with given branch and options with token', async function () {
+            const stdout = await fetch('this-is-token', 'my-branch', 'opt1', 'opt2');
+            const args = fakedExec.lastArgs;
+
+            eq(stdout, 'this is test');
+            ok(args);
+            eq(args[0], 'git');
+            eq(
+                args[1],
+                userArgs.concat([
+                    'fetch',
+                    'https://x-access-token:[email protected]/user/repo.git',
+                    'my-branch:my-branch',
+                    'opt1',
+                    'opt2',
+                ]),
+            );
+        });
+
+        it('runs `git fetch` with given branch and options without token', async function () {
+            const stdout = await fetch(undefined, 'my-branch', 'opt1', 'opt2');
+            const args = fakedExec.lastArgs;
+
+            eq(stdout, 'this is test');
+            ok(args);
+            eq(args[0], 'git');
+            eq(args[1], userArgs.concat(['fetch', 'origin', 'my-branch:my-branch', 'opt1', 'opt2']));
+        });
+
+        it('raises an error when repository info is not included in payload', async function () {
+            gitHubContext.payload.repository = null;
+            await A.rejects(
+                () => fetch('this-is-token', 'my-branch', 'opt1', 'opt2'),
+                /^Error: Repository info is not available in payload/,
+            );
+            eq(fakedExec.lastArgs, null);
+        });
+    });
 });

test/write.ts

@@ -50,7 +50,7 @@ class FakedOctokit {
     }
 }
 
-type GitFunc = 'cmd' | 'push' | 'pull';
+type GitFunc = 'cmd' | 'push' | 'pull' | 'fetch';
 class GitSpy {
     history: [GitFunc, unknown[]][];
     pushFailure: null | string;
@@ -134,6 +134,10 @@ mock('../src/git', {
         gitSpy.call('pull', args);
         return '';
     },
+    async fetch(...args: unknown[]) {
+        gitSpy.call('fetch', args);
+        return '';
+    },
 });
 
 const writeBenchmark: (b: Benchmark, c: Config) => Promise<any> = require('../src/write').writeBenchmark;
@@ -933,7 +937,7 @@ describe('writeBenchmark()', function () {
             const autoPush = cfg.autoPush ?? true;
             const skipFetch = cfg.skipFetch ?? false;
             const hist: Array<[GitFunc, unknown[]] | undefined> = [
-                skipFetch ? undefined : ['cmd', ['fetch', 'origin', 'gh-pages:gh-pages']],
+                skipFetch ? undefined : ['fetch', [token, 'gh-pages']],
                 ['cmd', ['switch', 'gh-pages']],
                 fetch ? ['pull', [token, 'gh-pages']] : undefined,
                 ['cmd', ['add', path.join(dir, 'data.js')]],