Merge 65f77605c0 into 85e6279cec

Adjust positioning of user email note and permissions heading (#2044 )
Documentation update - add recommended permissions to Readme (#2043 )
2025-09-11 18:22:21 +08:00 · 2025-01-27 14:12:05 +00:00 · 2025-01-16 15:56:18 -05:00 · 2025-01-16 14:14:48 -05:00 · 2023-10-28 11:30:25 -04:00
12 changed files with 120 additions and 39 deletions
--- a/README.md
+++ b/README.md
@@ -103,6 +103,11 @@ 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: ''
@@ -311,8 +316,17 @@ jobs:
          git commit -m "generated"
          git push
 ```
+
 *NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D

+# Recommended permissions
+
+When using the `checkout` action in your GitHub Actions workflow, it is recommended to set the following `GITHUB_TOKEN` permissions to ensure proper functionality, unless alternative auth is provided via the `token` or `ssh-key` inputs:
+
+```yaml
+permissions:
+  contents: read
+```

 # License

--- a/test/git-auth-helper.test.ts
+++ b/test/git-auth-helper.test.ts
@@ -763,6 +763,7 @@ 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) => {
@@ -824,7 +825,8 @@ async function setup(testName: string): Promise<void> {
    sshUser: '',
    workflowOrganizationId: 123456,
    setSafeDirectory: true,
-    githubServerUrl: githubServerUrl
+    githubServerUrl: githubServerUrl,
+    reference: '/some/path'
  }
 }

--- a/test/git-directory-helper.test.ts
+++ b/test/git-directory-helper.test.ts
@@ -478,6 +478,7 @@ 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(),
--- a/test/input-helper.test.ts
+++ b/test/input-helper.test.ts
@@ -91,6 +91,7 @@ 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 () => {
--- a/action.yml
+++ b/action.yml
@@ -80,6 +80,12 @@ 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
--- a/dist/index.js
+++ b/dist/index.js
@@ -748,6 +748,13 @@ 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];
    }
@@ -1239,6 +1246,17 @@ 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');
@@ -1831,6 +1849,8 @@ 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;
    });
 }
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,7 +9,7 @@
      "version": "4.2.2",
      "license": "MIT",
      "dependencies": {
-        "@actions/core": "^1.11.1",
+        "@actions/core": "^1.10.1",
        "@actions/exec": "^1.1.1",
        "@actions/github": "^6.0.0",
        "@actions/io": "^1.1.3",
@@ -17,21 +17,21 @@
        "uuid": "^9.0.1"
      },
      "devDependencies": {
-        "@types/jest": "^29.5.14",
+        "@types/jest": "^29.5.12",
        "@types/node": "^20.12.12",
        "@types/uuid": "^9.0.8",
        "@typescript-eslint/eslint-plugin": "^7.9.0",
        "@typescript-eslint/parser": "^7.9.0",
-        "@vercel/ncc": "^0.38.3",
+        "@vercel/ncc": "^0.38.1",
        "eslint": "^8.57.0",
        "eslint-plugin-github": "^4.10.2",
-        "eslint-plugin-jest": "^28.9.0",
+        "eslint-plugin-jest": "^28.8.2",
        "jest": "^29.7.0",
        "jest-circus": "^29.7.0",
        "js-yaml": "^4.1.0",
-        "prettier": "^3.4.1",
+        "prettier": "^3.3.3",
        "ts-jest": "^29.2.5",
-        "typescript": "^5.7.2"
+        "typescript": "^5.5.4"
      }
    },
    "node_modules/@aashutoshrathi/word-wrap": {
@@ -44,13 +44,20 @@
      }
    },
    "node_modules/@actions/core": {
-      "version": "1.11.1",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.11.1.tgz",
-      "integrity": "sha512-hXJCSrkwfA46Vd9Z3q4cpEpHB1rL5NG04+/rbqW9d3+CSvtB1tYe8UTpAlixa1vj0m/ULglfEK2UKxMGxCxv5A==",
-      "license": "MIT",
+      "version": "1.10.1",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.1.tgz",
+      "integrity": "sha512-3lBR9EDAY+iYIpTnTIXmWcNbX3T2kCkAEQGIQx4NVQ0575nk2k3GRZDTPQG+vVtS2izSLmINlxXf0uLtnrTP+g==",
      "dependencies": {
-        "@actions/exec": "^1.1.1",
-        "@actions/http-client": "^2.0.1"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
+      }
+    },
+    "node_modules/@actions/core/node_modules/uuid": {
+      "version": "8.3.2",
+      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
+      "bin": {
+        "uuid": "dist/bin/uuid"
      }
    },
    "node_modules/@actions/exec": {
@@ -1565,11 +1572,10 @@
      }
    },
    "node_modules/@types/jest": {
-      "version": "29.5.14",
-      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.14.tgz",
-      "integrity": "sha512-ZN+4sdnLUbo8EVvVc2ao0GFW6oVrQRPn4K2lglySj7APvSrgzxHiNNK99us4WDMi57xxA2yggblIAMNhXOotLQ==",
+      "version": "29.5.12",
+      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.12.tgz",
+      "integrity": "sha512-eDC8bTvT/QhYdxJAulQikueigY5AsdBRH2yDKW3yveW7svY3+DzN84/2NUgkw10RTiJbWqZrTtoGVdYlvFJdLw==",
      "dev": true,
-      "license": "MIT",
      "dependencies": {
        "expect": "^29.0.0",
        "pretty-format": "^29.0.0"
@@ -1821,11 +1827,10 @@
      "dev": true
    },
    "node_modules/@vercel/ncc": {
-      "version": "0.38.3",
-      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.38.3.tgz",
-      "integrity": "sha512-rnK6hJBS6mwc+Bkab+PGPs9OiS0i/3kdTO+CkI8V0/VrW3vmz7O2Pxjw/owOlmo6PKEIxRSeZKv/kuL9itnpYA==",
+      "version": "0.38.1",
+      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.38.1.tgz",
+      "integrity": "sha512-IBBb+iI2NLu4VQn3Vwldyi2QwaXt5+hTyh58ggAMoCGE6DJmPvwL3KPBWcJl1m9LYPChBLE980Jw+CS4Wokqxw==",
      "dev": true,
-      "license": "MIT",
      "bin": {
        "ncc": "dist/ncc/cli.js"
      }
@@ -3213,11 +3218,10 @@
      }
    },
    "node_modules/eslint-plugin-jest": {
-      "version": "28.9.0",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-28.9.0.tgz",
-      "integrity": "sha512-rLu1s1Wf96TgUUxSw6loVIkNtUjq1Re7A9QdCCHSohnvXEBAjuL420h0T/fMmkQlNsQP2GhQzEUpYHPfxBkvYQ==",
+      "version": "28.8.2",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-28.8.2.tgz",
+      "integrity": "sha512-mC3OyklHmS5i7wYU1rGId9EnxRI8TVlnFG56AE+8U9iRy6zwaNygZR+DsdZuCL0gRG0wVeyzq+uWcPt6yJrrMA==",
      "dev": true,
-      "license": "MIT",
      "dependencies": {
        "@typescript-eslint/utils": "^6.0.0 || ^7.0.0 || ^8.0.0"
      },
@@ -5974,11 +5978,10 @@
      }
    },
    "node_modules/prettier": {
-      "version": "3.4.1",
-      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.4.1.tgz",
-      "integrity": "sha512-G+YdqtITVZmOJje6QkXQWzl3fSfMxFwm1tjTyo9exhkmWSqC4Yhd1+lug++IlR2mvRVAxEDDWYkQdeSztajqgg==",
+      "version": "3.3.3",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz",
+      "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==",
      "dev": true,
-      "license": "MIT",
      "bin": {
        "prettier": "bin/prettier.cjs"
      },
@@ -6899,11 +6902,10 @@
      }
    },
    "node_modules/typescript": {
-      "version": "5.7.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.2.tgz",
-      "integrity": "sha512-i5t66RHxDvVN40HfDd1PsEThGNnlMCMT3jMUuoh9/0TaqWevNontacunWyN02LA9/fIbEWlcHZcgTKb9QoaLfg==",
+      "version": "5.5.4",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz",
+      "integrity": "sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q==",
      "dev": true,
-      "license": "Apache-2.0",
      "bin": {
        "tsc": "bin/tsc",
        "tsserver": "bin/tsserver"
--- a/package.json
+++ b/package.json
@@ -28,7 +28,7 @@
  },
  "homepage": "https://github.com/actions/checkout#readme",
  "dependencies": {
-    "@actions/core": "^1.11.1",
+    "@actions/core": "^1.10.1",
    "@actions/exec": "^1.1.1",
    "@actions/github": "^6.0.0",
    "@actions/io": "^1.1.3",
@@ -36,20 +36,20 @@
    "uuid": "^9.0.1"
  },
  "devDependencies": {
-    "@types/jest": "^29.5.14",
+    "@types/jest": "^29.5.12",
    "@types/node": "^20.12.12",
    "@types/uuid": "^9.0.8",
    "@typescript-eslint/eslint-plugin": "^7.9.0",
    "@typescript-eslint/parser": "^7.9.0",
-    "@vercel/ncc": "^0.38.3",
+    "@vercel/ncc": "^0.38.1",
    "eslint": "^8.57.0",
    "eslint-plugin-github": "^4.10.2",
-    "eslint-plugin-jest": "^28.9.0",
+    "eslint-plugin-jest": "^28.8.2",
    "jest": "^29.7.0",
    "jest-circus": "^29.7.0",
    "js-yaml": "^4.1.0",
-    "prettier": "^3.4.1",
+    "prettier": "^3.3.3",
    "ts-jest": "^29.2.5",
-    "typescript": "^5.7.2"
+    "typescript": "^5.5.4"
  }
 }
--- a/src/git-command-manager.ts
+++ b/src/git-command-manager.ts
@@ -48,6 +48,7 @@ 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
@@ -364,6 +365,15 @@ 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]
  }
--- a/src/git-source-provider.ts
+++ b/src/git-source-provider.ts
@@ -113,6 +113,18 @@ 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
--- a/src/git-source-settings.ts
+++ b/src/git-source-settings.ts
@@ -49,6 +49,11 @@ export interface IGitSourceSettings {
   */
  fetchDepth: number

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

+  /**
+   * The local reference repository
+   */
+  reference: string | undefined
+
  /**
   * Indicates whether to fetch LFS objects
   */
--- a/src/input-helper.ts
+++ b/src/input-helper.ts
@@ -161,5 +161,8 @@ 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
 }
Author	SHA1	Message	Date
Nacho Orlandoni	8c2f86ce2e	Merge `65f77605c0` into `85e6279cec`	2025-01-27 14:12:05 +00:00
Josh Gross	85e6279cec	Adjust positioning of user email note and permissions heading (#2044 ) Some checks failed CodeQL / Analyze (javascript) (push) Has been cancelled Details Build and Test / build (push) Has been cancelled Details Build and Test / test (macos-latest) (push) Has been cancelled Details Build and Test / test (ubuntu-latest) (push) Has been cancelled Details Build and Test / test (windows-latest) (push) Has been cancelled Details Build and Test / test-proxy (push) Has been cancelled Details Build and Test / test-bypass-proxy (push) Has been cancelled Details Build and Test / test-git-container (push) Has been cancelled Details Build and Test / test-output (push) Has been cancelled Details	2025-01-16 15:56:18 -05:00
Ben Wells	009b9ae9e4	Documentation update - add recommended permissions to Readme (#2043 ) * Update README.md * Update README.md Co-authored-by: Josh Gross <joshmgross@github.com> --------- Co-authored-by: Josh Gross <joshmgross@github.com>	2025-01-16 14:14:48 -05:00
Nacho Orlandoni	65f77605c0	Reference support * Add support for reference repository parameter --------- Co-authored-by: Diego Dompe <ddompe@gmail.com>	2023-10-28 11:30:25 -04:00