Prepare 4.2.2 Release (#1953)

* Prepare 4.2.2 Release

---------

Co-authored-by: Josh Gross <joshmgross@github.com>

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v4.2.2
+* `url-helper.ts` now leverages well-known environment variables by @jww3 in https://github.com/actions/checkout/pull/1941
+* Expand unit test coverage for `isGhes` by @jww3 in https://github.com/actions/checkout/pull/1946
+
 ## v4.2.1
 * Check out other refs/* by commit if provided, fall back to ref by @orhantoy in https://github.com/actions/checkout/pull/1924
 

README.md

@@ -103,11 +103,6 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
     # Default: true
     show-progress: ''
 
-    # Path to a local bare git [reference repository to minimize network
-    # usage](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---reference-if-ableltrepositorygt).
-    # If the directory doesn't exists this option will ignore it and log a message.
-    reference: ''
-
     # Whether to download Git-LFS files
     # Default: false
     lfs: ''

__test__/git-auth-helper.test.ts

@@ -763,7 +763,6 @@ async function setup(testName: string): Promise<void> {
     lfsInstall: jest.fn(),
     log1: jest.fn(),
     remoteAdd: jest.fn(),
-    referenceAdd: jest.fn(),
     removeEnvironmentVariable: jest.fn((name: string) => delete git.env[name]),
     revParse: jest.fn(),
     setEnvironmentVariable: jest.fn((name: string, value: string) => {
@@ -825,8 +824,7 @@ async function setup(testName: string): Promise<void> {
     sshUser: '',
     workflowOrganizationId: 123456,
     setSafeDirectory: true,
-    githubServerUrl: githubServerUrl,
-    reference: '/some/path'
+    githubServerUrl: githubServerUrl
   }
 }
 

__test__/git-directory-helper.test.ts

@@ -478,7 +478,6 @@ async function setup(testName: string): Promise<void> {
     lfsInstall: jest.fn(),
     log1: jest.fn(),
     remoteAdd: jest.fn(),
-    referenceAdd: jest.fn(),
     removeEnvironmentVariable: jest.fn(),
     revParse: jest.fn(),
     setEnvironmentVariable: jest.fn(),

__test__/input-helper.test.ts

@@ -91,7 +91,6 @@ describe('input-helper tests', () => {
     expect(settings.repositoryOwner).toBe('some-owner')
     expect(settings.repositoryPath).toBe(gitHubWorkspace)
     expect(settings.setSafeDirectory).toBe(true)
-    expect(settings.reference).toBe(undefined)
   })
 
   it('qualifies ref', async () => {

__test__/url-helper.test.ts

@@ -24,13 +24,50 @@ describe('getServerUrl tests', () => {
 })
 
 describe('isGhes tests', () => {
+  const pristineEnv = process.env
+
+  beforeEach(() => {
+    jest.resetModules()
+    process.env = {...pristineEnv}
+  })
+
+  afterAll(() => {
+    process.env = pristineEnv
+  })
+
   it('basics', async () => {
+    delete process.env['GITHUB_SERVER_URL']
     expect(urlHelper.isGhes()).toBeFalsy()
     expect(urlHelper.isGhes('https://github.com')).toBeFalsy()
     expect(urlHelper.isGhes('https://contoso.ghe.com')).toBeFalsy()
     expect(urlHelper.isGhes('https://test.github.localhost')).toBeFalsy()
     expect(urlHelper.isGhes('https://src.onpremise.fabrikam.com')).toBeTruthy()
   })
+
+  it('returns false when the GITHUB_SERVER_URL environment variable is not defined', async () => {
+    delete process.env['GITHUB_SERVER_URL']
+    expect(urlHelper.isGhes()).toBeFalsy()
+  })
+
+  it('returns false when the GITHUB_SERVER_URL environment variable is set to github.com', async () => {
+    process.env['GITHUB_SERVER_URL'] = 'https://github.com'
+    expect(urlHelper.isGhes()).toBeFalsy()
+  })
+
+  it('returns false when the GITHUB_SERVER_URL environment variable is set to a GitHub Enterprise Cloud-style URL', async () => {
+    process.env['GITHUB_SERVER_URL'] = 'https://contoso.ghe.com'
+    expect(urlHelper.isGhes()).toBeFalsy()
+  })
+
+  it('returns false when the GITHUB_SERVER_URL environment variable has a .localhost suffix', async () => {
+    process.env['GITHUB_SERVER_URL'] = 'https://mock-github.localhost'
+    expect(urlHelper.isGhes()).toBeFalsy()
+  })
+
+  it('returns true when the GITHUB_SERVER_URL environment variable is set to some other URL', async () => {
+    process.env['GITHUB_SERVER_URL'] = 'https://src.onpremise.fabrikam.com'
+    expect(urlHelper.isGhes()).toBeTruthy()
+  })
 })
 
 describe('getServerApiUrl tests', () => {

action.yml

@@ -80,12 +80,6 @@ inputs:
   show-progress:
     description: 'Whether to show progress status output when fetching.'
     default: true
-  reference:
-    required: false
-    description: >
-      Path to a local bare git [reference repository to minimize network usage](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---reference-if-ableltrepositorygt).
-      
-      If the directory doesn't exists this option will ignore it and log a message.
   lfs:
     description: 'Whether to download Git-LFS files'
     default: false

dist/index.js

@@ -748,13 +748,6 @@ class GitCommandManager {
             yield this.execGit(['remote', 'add', remoteName, remoteUrl]);
         });
     }
-    referenceAdd(alternateObjects) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const alternatePath = path.join(this.workingDirectory, '.git/objects/info/alternates');
-            core.info(`Adding a git alternate to reference repo at ${alternateObjects}`);
-            yield fs.promises.writeFile(alternatePath, `${alternateObjects}\n`);
-        });
-    }
     removeEnvironmentVariable(name) {
         delete this.gitEnv[name];
     }
@@ -1246,17 +1239,6 @@ function getSource(settings) {
                 yield git.init();
                 yield git.remoteAdd('origin', repositoryUrl);
                 core.endGroup();
-                if (settings.reference !== undefined) {
-                    const alternateObjects = path.join(settings.reference, '/objects');
-                    if (fsHelper.directoryExistsSync(alternateObjects, false)) {
-                        core.startGroup('Adding a reference repository');
-                        yield git.referenceAdd(alternateObjects);
-                        core.endGroup();
-                    }
-                    else {
-                        core.warning(`Reference repository was specified, but directory ${alternateObjects} does not exists`);
-                    }
-                }
             }
             // Disable automatic garbage collection
             core.startGroup('Disabling automatic garbage collection');
@@ -1849,8 +1831,6 @@ function getInputs() {
         // Determine the GitHub URL that the repository is being hosted from
         result.githubServerUrl = core.getInput('github-server-url');
         core.debug(`GitHub Host URL = ${result.githubServerUrl}`);
-        result.reference = core.getInput('reference');
-        core.debug(`Reference repository = ${result.reference}`);
         return result;
     });
 }

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "checkout",
-  "version": "4.2.1",
+  "version": "4.2.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "checkout",
-      "version": "4.2.1",
+      "version": "4.2.2",
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.10.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "checkout",
-  "version": "4.2.1",
+  "version": "4.2.2",
   "description": "checkout action",
   "main": "lib/main.js",
   "scripts": {

src/git-command-manager.ts

@@ -48,7 +48,6 @@ export interface IGitCommandManager {
   lfsInstall(): Promise<void>
   log1(format?: string): Promise<string>
   remoteAdd(remoteName: string, remoteUrl: string): Promise<void>
-  referenceAdd(reference: string): Promise<void>
   removeEnvironmentVariable(name: string): void
   revParse(ref: string): Promise<string>
   setEnvironmentVariable(name: string, value: string): void
@@ -365,15 +364,6 @@ class GitCommandManager {
     await this.execGit(['remote', 'add', remoteName, remoteUrl])
   }
 
-  async referenceAdd(alternateObjects: string): Promise<void> {
-    const alternatePath = path.join(
-      this.workingDirectory,
-      '.git/objects/info/alternates'
-    )
-    core.info(`Adding a git alternate to reference repo at ${alternateObjects}`)
-    await fs.promises.writeFile(alternatePath, `${alternateObjects}\n`)
-  }
-
   removeEnvironmentVariable(name: string): void {
     delete this.gitEnv[name]
   }

src/git-source-provider.ts

@@ -113,18 +113,6 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
       await git.init()
       await git.remoteAdd('origin', repositoryUrl)
       core.endGroup()
-
-      if (settings.reference !== undefined) {
-        const alternateObjects = path.join(settings.reference, '/objects')
-
-        if (fsHelper.directoryExistsSync(alternateObjects, false)) {
-          core.startGroup('Adding a reference repository')
-          await git.referenceAdd(alternateObjects)
-          core.endGroup()
-        } else {
-          core.warning(`Reference repository was specified, but directory ${alternateObjects} does not exists`);
-        }
-      }
     }
 
     // Disable automatic garbage collection

src/git-source-settings.ts

@@ -49,11 +49,6 @@ export interface IGitSourceSettings {
    */
   fetchDepth: number
 
-  /**
-   * The local reference repository
-   */
-  reference: string | undefined
-
   /**
    * Fetch tags, even if fetchDepth > 0 (default: false)
    */
@@ -64,11 +59,6 @@ export interface IGitSourceSettings {
    */
   showProgress: boolean
 
-  /**
-   * The local reference repository
-   */
-  reference: string | undefined
-
   /**
    * Indicates whether to fetch LFS objects
    */

src/input-helper.ts

@@ -161,8 +161,5 @@ export async function getInputs(): Promise<IGitSourceSettings> {
   result.githubServerUrl = core.getInput('github-server-url')
   core.debug(`GitHub Host URL = ${result.githubServerUrl}`)
 
-  result.reference = core.getInput('reference')
-  core.debug(`Reference repository = ${result.reference}`)
-
   return result
 }