diff --git a/README.md b/README.md index 7ec08ce..bfecf46 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Only a single commit is fetched by default, for the ref/SHA that triggered the w The auth token is persisted in the local git config. This enables your scripts to run authenticated git commands. The token is removed during post-job cleanup. Set `persist-credentials: false` to opt-out. -When Git 2.28 or higher is not in your PATH, falls back to the REST API to download the files. +When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files. # What's new diff --git a/__test__/git-command-manager.test.ts b/__test__/git-command-manager.test.ts index e7af4c9..cea73d4 100644 --- a/__test__/git-command-manager.test.ts +++ b/__test__/git-command-manager.test.ts @@ -24,7 +24,7 @@ describe('git-auth-helper tests', () => { console.log(args, options.listeners.stdout) if (args.includes('version')) { - options.listeners.stdout(Buffer.from('2.28')) + options.listeners.stdout(Buffer.from('2.18')) return 0 } @@ -57,7 +57,7 @@ describe('git-auth-helper tests', () => { console.log(args, options.listeners.stdout) if (args.includes('version')) { - options.listeners.stdout(Buffer.from('2.28')) + options.listeners.stdout(Buffer.from('2.18')) return 0 } @@ -97,7 +97,7 @@ describe('Test fetchDepth and fetchTags options', () => { console.log(args, options.listeners.stdout) if (args.includes('version')) { - options.listeners.stdout(Buffer.from('2.28')) + options.listeners.stdout(Buffer.from('2.18')) } return 0 diff --git a/dist/index.js b/dist/index.js index 72e40d8..1389602 100644 --- a/dist/index.js +++ b/dist/index.js @@ -480,8 +480,7 @@ const retryHelper = __importStar(__nccwpck_require__(2155)); const git_version_1 = __nccwpck_require__(3142); // Auth header not supported before 2.9 // Wire protocol v2 not supported before 2.18 -// sparse-checkout not [well-]supported before 2.28 (see https://github.com/actions/checkout/issues/1386) -exports.MinimumGitVersion = new git_version_1.GitVersion('2.28'); +exports.MinimumGitVersion = new git_version_1.GitVersion('2.18'); function createCommandManager(workingDirectory, lfs, doSparseCheckout) { return __awaiter(this, void 0, void 0, function* () { return yield GitCommandManager.createCommandManager(workingDirectory, lfs, doSparseCheckout); @@ -524,7 +523,13 @@ class GitCommandManager { branchList(remote) { return __awaiter(this, void 0, void 0, function* () { const result = []; - const args = ['rev-parse', '--symbolic']; + // Note, this implementation uses "rev-parse --symbolic-full-name" because the output from + // "branch --list" is more difficult when in a detached HEAD state. + // TODO(https://github.com/actions/checkout/issues/786): this implementation uses + // "rev-parse --symbolic-full-name" because there is a bug + // in Git 2.18 that causes "rev-parse --symbolic" to output symbolic full names. When + // 2.18 is no longer supported, we can switch back to --symbolic. + const args = ['rev-parse', '--symbolic-full-name']; if (remote) { args.push('--remotes=origin'); } @@ -937,6 +942,13 @@ class GitCommandManager { } } this.doSparseCheckout = doSparseCheckout; + if (this.doSparseCheckout) { + // The `git sparse-checkout` command was introduced in Git v2.25.0 + const minimumGitSparseCheckoutVersion = new git_version_1.GitVersion('2.25'); + if (!gitVersion.checkMinimum(minimumGitSparseCheckoutVersion)) { + throw new Error(`Minimum Git version required for sparse checkout is ${minimumGitSparseCheckoutVersion}. Your git ('${this.gitPath}') is ${gitVersion}`); + } + } // Set the user agent const gitHttpUserAgent = `git/${gitVersion} (github-actions-checkout)`; core.debug(`Set git useragent to: ${gitHttpUserAgent}`); diff --git a/package-lock.json b/package-lock.json index ce0af4e..9834e50 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "checkout", - "version": "5.0.0", + "version": "4.1.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "checkout", - "version": "5.0.0", + "version": "4.1.2", "license": "MIT", "dependencies": { "@actions/core": "^1.10.0", diff --git a/package.json b/package.json index 2febd44..651d6a0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "checkout", - "version": "5.0.0", + "version": "4.1.2", "description": "checkout action", "main": "lib/main.js", "scripts": { diff --git a/src/git-command-manager.ts b/src/git-command-manager.ts index 1ce9aa3..0f3fd25 100644 --- a/src/git-command-manager.ts +++ b/src/git-command-manager.ts @@ -11,8 +11,7 @@ import {GitVersion} from './git-version' // Auth header not supported before 2.9 // Wire protocol v2 not supported before 2.18 -// sparse-checkout not [well-]supported before 2.28 (see https://github.com/actions/checkout/issues/1386) -export const MinimumGitVersion = new GitVersion('2.28') +export const MinimumGitVersion = new GitVersion('2.18') export interface IGitCommandManager { branchDelete(remote: boolean, branch: string): Promise @@ -111,7 +110,16 @@ class GitCommandManager { async branchList(remote: boolean): Promise { const result: string[] = [] - const args = ['rev-parse', '--symbolic'] + + // Note, this implementation uses "rev-parse --symbolic-full-name" because the output from + // "branch --list" is more difficult when in a detached HEAD state. + + // TODO(https://github.com/actions/checkout/issues/786): this implementation uses + // "rev-parse --symbolic-full-name" because there is a bug + // in Git 2.18 that causes "rev-parse --symbolic" to output symbolic full names. When + // 2.18 is no longer supported, we can switch back to --symbolic. + + const args = ['rev-parse', '--symbolic-full-name'] if (remote) { args.push('--remotes=origin') } else { @@ -597,7 +605,15 @@ class GitCommandManager { } this.doSparseCheckout = doSparseCheckout - + if (this.doSparseCheckout) { + // The `git sparse-checkout` command was introduced in Git v2.25.0 + const minimumGitSparseCheckoutVersion = new GitVersion('2.25') + if (!gitVersion.checkMinimum(minimumGitSparseCheckoutVersion)) { + throw new Error( + `Minimum Git version required for sparse checkout is ${minimumGitSparseCheckoutVersion}. Your git ('${this.gitPath}') is ${gitVersion}` + ) + } + } // Set the user agent const gitHttpUserAgent = `git/${gitVersion} (github-actions-checkout)` core.debug(`Set git useragent to: ${gitHttpUserAgent}`)