add support for gist.github.com

actions · May 30, 2020 · 9c88fe4 · 9c88fe4
1 parent aabbfeb
commit 9c88fe4
Showing 10 changed files with 79 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -40,6 +40,9 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
     # Default: ${{ github.repository }}
     repository: ''
 
+    # Gist name with owner. For example, schacon/1
+    gist: ''
+
     # The branch, tag or SHA to checkout. When checking out the repository that
     # triggered a workflow, this defaults to the reference or SHA for that event.
     # Otherwise, defaults to `master`.

diff --git a/__test__/git-auth-helper.test.ts b/__test__/git-auth-helper.test.ts
@@ -767,6 +767,7 @@ async function setup(testName: string): Promise<void> {
     repositoryName: 'my-repo',
     repositoryOwner: 'my-org',
     repositoryPath: '',
+    isGist: false,
     sshKey: sshPath ? 'some ssh private key' : '',
     sshKnownHosts: '',
     sshStrict: true

diff --git a/__test__/input-helper.test.ts b/__test__/input-helper.test.ts
@@ -117,6 +117,13 @@ describe('input-helper tests', () => {
     expect(settings.commit).toBeFalsy()
   })
 
+  it('sets correct default ref/sha for gist', () => {
+    inputs.gist = 'some-owner/some-gist'
+    const settings: IGitSourceSettings = inputHelper.getInputs()
+    expect(settings.ref).toBe('refs/heads/master')
+    expect(settings.commit).toBeFalsy()
+  })
+
   it('sets ref to empty when explicit sha', () => {
     inputs.ref = '1111111111222222222233333333334444444444'
     const settings: IGitSourceSettings = inputHelper.getInputs()

diff --git a/action.yml b/action.yml
@@ -4,6 +4,8 @@ inputs:
   repository:
     description: 'Repository name with owner. For example, actions/checkout'
     default: ${{ github.repository }}
+  gist:
+    description: 'Gist name with owner. For example, schacon/1'
   ref:
     description: >
       The branch, tag or SHA to checkout. When checking out the repository that

diff --git a/dist/index.js b/dist/index.js
@@ -1389,21 +1389,30 @@ const url_1 = __webpack_require__(835);
 function getFetchUrl(settings) {
     assert.ok(settings.repositoryOwner, 'settings.repositoryOwner must be defined');
     assert.ok(settings.repositoryName, 'settings.repositoryName must be defined');
-    const serviceUrl = getServerUrl();
+    const serviceUrl = getServerUrl(settings.isGist);
     const encodedOwner = encodeURIComponent(settings.repositoryOwner);
     const encodedName = encodeURIComponent(settings.repositoryName);
+    let encodedNwo = `${encodedOwner}/${encodedName}`;
+    if (settings.isGist) {
+        encodedNwo = encodedName;
+    }
     if (settings.sshKey) {
-        return `git@${serviceUrl.hostname}:${encodedOwner}/${encodedName}.git`;
+        return `git@${serviceUrl.hostname}:${encodedNwo}.git`;
     }
     // "origin" is SCHEME://HOSTNAME[:PORT]
-    return `${serviceUrl.origin}/${encodedOwner}/${encodedName}`;
+    return `${serviceUrl.origin}/${encodedNwo}`;
 }
 exports.getFetchUrl = getFetchUrl;
-function getServerUrl() {
+function getServerUrl(isGist) {
     // todo: remove GITHUB_URL after support for GHES Alpha is no longer needed
-    return new url_1.URL(process.env['GITHUB_SERVER_URL'] ||
+    let serverUrl = new url_1.URL(process.env['GITHUB_SERVER_URL'] ||
         process.env['GITHUB_URL'] ||
         'https://github.com');
+    // todo: don't assume subdomain isolation
+    if (isGist) {
+        serverUrl.hostname = `gist.${serverUrl.hostname}`;
+    }
+    return serverUrl;
 }
 exports.getServerUrl = getServerUrl;
 
@@ -5418,7 +5427,7 @@ class GitAuthHelper {
         this.git = gitCommandManager;
         this.settings = gitSourceSettings || {};
         // Token auth header
-        const serverUrl = urlHelper.getServerUrl();
+        const serverUrl = urlHelper.getServerUrl(this.settings.isGist);
         this.tokenConfigKey = `http.${serverUrl.origin}/.extraheader`; // "origin" is SCHEME://HOSTNAME[:PORT]
         const basicCredential = Buffer.from(`x-access-token:${this.settings.authToken}`, 'utf8').toString('base64');
         core.setSecret(basicCredential);
@@ -6163,9 +6172,11 @@ function getSource(settings) {
         const authHelper = gitAuthHelper.createAuthHelper(git, settings);
         try {
             // Configure auth
-            core.startGroup('Setting up auth');
-            yield authHelper.configureAuth();
-            core.endGroup();
+            if (!settings.isGist) {
+                core.startGroup('Setting up auth');
+                yield authHelper.configureAuth();
+                core.endGroup();
+            }
             // LFS install
             if (settings.lfs) {
                 yield git.lfsInstall();
@@ -14438,15 +14449,22 @@ function getInputs() {
     githubWorkspacePath = path.resolve(githubWorkspacePath);
     core.debug(`GITHUB_WORKSPACE = '${githubWorkspacePath}'`);
     fsHelper.directoryExistsSync(githubWorkspacePath, true);
+    // Gist repository?
+    result.isGist = !!core.getInput('gist') || false;
+    core.debug(`isGist = '${result.isGist}'`);
     // Qualified repository
-    const qualifiedRepository = core.getInput('repository') ||
+    let qualifiedRepository = core.getInput('repository') ||
         `${github.context.repo.owner}/${github.context.repo.repo}`;
+    if (result.isGist) {
+        qualifiedRepository = core.getInput('gist');
+    }
     core.debug(`qualified repository = '${qualifiedRepository}'`);
     const splitRepository = qualifiedRepository.split('/');
     if (splitRepository.length !== 2 ||
         !splitRepository[0] ||
         !splitRepository[1]) {
-        throw new Error(`Invalid repository '${qualifiedRepository}'. Expected format {owner}/{repo}.`);
+        const model = result.isGist ? 'gist' : 'repository';
+        throw new Error(`Invalid ${model} '${qualifiedRepository}'. Expected format {owner}/{repo}.`);
     }
     result.repositoryOwner = splitRepository[0];
     result.repositoryName = splitRepository[1];

diff --git a/src/git-auth-helper.ts b/src/git-auth-helper.ts
@@ -51,7 +51,7 @@ class GitAuthHelper {
     this.settings = gitSourceSettings || (({} as unknown) as IGitSourceSettings)
 
     // Token auth header
-    const serverUrl = urlHelper.getServerUrl()
+    const serverUrl = urlHelper.getServerUrl(this.settings.isGist)
     this.tokenConfigKey = `http.${serverUrl.origin}/.extraheader` // "origin" is SCHEME://HOSTNAME[:PORT]
     const basicCredential = Buffer.from(
       `x-access-token:${this.settings.authToken}`,

diff --git a/src/git-source-provider.ts b/src/git-source-provider.ts
@@ -99,9 +99,11 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
   const authHelper = gitAuthHelper.createAuthHelper(git, settings)
   try {
     // Configure auth
-    core.startGroup('Setting up auth')
-    await authHelper.configureAuth()
-    core.endGroup()
+    if (!settings.isGist) {
+      core.startGroup('Setting up auth')
+      await authHelper.configureAuth()
+      core.endGroup()
+    }
 
     // LFS install
     if (settings.lfs) {

diff --git a/src/git-source-settings.ts b/src/git-source-settings.ts
@@ -73,4 +73,9 @@ export interface IGitSourceSettings {
    * Indicates whether to persist the credentials on disk to enable scripting authenticated git commands
    */
   persistCredentials: boolean
+
+  /**
+   * Indicates whether this repository is a gist
+   */
+  isGist: boolean
 }
diff --git a/src/input-helper.ts b/src/input-helper.ts
@@ -16,19 +16,27 @@ export function getInputs(): IGitSourceSettings {
   core.debug(`GITHUB_WORKSPACE = '${githubWorkspacePath}'`)
   fsHelper.directoryExistsSync(githubWorkspacePath, true)
 
+  // Gist repository?
+  result.isGist = !!core.getInput('gist') || false
+  core.debug(`isGist = '${result.isGist}'`)
+
   // Qualified repository
-  const qualifiedRepository =
+  let qualifiedRepository =
     core.getInput('repository') ||
     `${github.context.repo.owner}/${github.context.repo.repo}`
+  if (result.isGist) {
+    qualifiedRepository = core.getInput('gist')
+  }
   core.debug(`qualified repository = '${qualifiedRepository}'`)
   const splitRepository = qualifiedRepository.split('/')
   if (
     splitRepository.length !== 2 ||
     !splitRepository[0] ||
     !splitRepository[1]
   ) {
+    const model = result.isGist ? 'gist' : 'repository'
     throw new Error(
-      `Invalid repository '${qualifiedRepository}'. Expected format {owner}/{repo}.`
+      `Invalid ${model} '${qualifiedRepository}'. Expected format {owner}/{repo}.`
     )
   }
   result.repositoryOwner = splitRepository[0]

diff --git a/src/url-helper.ts b/src/url-helper.ts
@@ -8,22 +8,33 @@ export function getFetchUrl(settings: IGitSourceSettings): string {
     'settings.repositoryOwner must be defined'
   )
   assert.ok(settings.repositoryName, 'settings.repositoryName must be defined')
-  const serviceUrl = getServerUrl()
+  const serviceUrl = getServerUrl(settings.isGist)
   const encodedOwner = encodeURIComponent(settings.repositoryOwner)
   const encodedName = encodeURIComponent(settings.repositoryName)
+  let encodedNwo = `${encodedOwner}/${encodedName}`
+  if (settings.isGist) {
+    encodedNwo = encodedName
+  }
   if (settings.sshKey) {
-    return `git@${serviceUrl.hostname}:${encodedOwner}/${encodedName}.git`
+    return `git@${serviceUrl.hostname}:${encodedNwo}.git`
   }
 
   // "origin" is SCHEME://HOSTNAME[:PORT]
-  return `${serviceUrl.origin}/${encodedOwner}/${encodedName}`
+  return `${serviceUrl.origin}/${encodedNwo}`
 }
 
-export function getServerUrl(): URL {
+export function getServerUrl(isGist: boolean): URL {
   // todo: remove GITHUB_URL after support for GHES Alpha is no longer needed
-  return new URL(
+  let serverUrl = new URL(
     process.env['GITHUB_SERVER_URL'] ||
       process.env['GITHUB_URL'] ||
       'https://github.com'
   )
+
+  // todo: don't assume subdomain isolation
+  if (isGist) {
+    serverUrl.hostname = `gist.${serverUrl.hostname}`
+  }
+
+  return serverUrl
 }