fix: bug with retrieving the base sha when since last commit is enabled (#1213)

Co-authored-by: GitHub Action <action@github.com>

.github/workflows/test.yml

@@ -316,6 +316,66 @@ jobs:
         shell:
           bash
 
+  test-pull-request-head-ref:
+    name: Test changed-files with pull request head ref
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name != 'push'
+
+    steps:
+      - name: Checkout to branch
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Download build assets
+        uses: actions/download-artifact@v3
+        with:
+          name: build-assets
+
+      - name: Run changed-files
+        id: changed-files
+        uses: ./
+
+      - name: Show output
+        run: |
+          echo '${{ toJSON(steps.changed-files.outputs) }}'
+        shell:
+          bash
+
+  test-pull-request-without-persist-credentials:
+    name: Test changed-files with pull request without persist credentials
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name != 'push'
+    strategy:
+      fail-fast: false
+      max-parallel: 4
+      matrix:
+        fetch-depth: [1, 2, 0]
+
+    steps:
+      - name: Checkout to branch
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: ${{ matrix.fetch-depth }}
+          persist-credentials: false
+
+      - name: Download build assets
+        uses: actions/download-artifact@v3
+        with:
+          name: build-assets
+
+      - name: Run changed-files
+        id: changed-files
+        uses: ./
+
+      - name: Show output
+        run: |
+          echo '${{ toJSON(steps.changed-files.outputs) }}'
+        shell:
+          bash
+
   test-non-existent-base-sha:
     name: Test changed-files non existent base sha
     runs-on: ubuntu-latest

README.md

@@ -82,10 +82,10 @@ on:
     branches:
       - main
 
-# -------------------------------------------------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------------------------------------
 # Event `push`: Compare the preceeding commit -> to the current commit of the main branch.
 # Event `pull_request`: Compare the last commit of main -> to the current commit of a Pull Request branch.
-# -------------------------------------------------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------------------------------------
 
 jobs:
   build:

dist/index.js

@@ -356,7 +356,7 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
     }
     if (isShallow) {
         core.info('Repository is shallow, fetching more history...');
-        const prFetchExitCode = yield (0, utils_1.gitFetch)({
+        let prFetchExitCode = yield (0, utils_1.gitFetch)({
             cwd: workingDirectory,
             args: [
                 ...gitExtraArgs,
@@ -367,7 +367,7 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
             ]
         });
         if (prFetchExitCode !== 0) {
-            yield (0, utils_1.gitFetch)({
+            prFetchExitCode = yield (0, utils_1.gitFetch)({
                 cwd: workingDirectory,
                 args: [
                     ...gitExtraArgs,
@@ -379,6 +379,9 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
                 ]
             });
         }
+        if (prFetchExitCode !== 0) {
+            throw new Error('Failed to fetch pull request branch. Please ensure "persist-credentials" is set to "true" when checking out the repository. See: https://github.com/actions/checkout#usage');
+        }
         if (!inputs.sinceLastRemoteCommit) {
             core.debug('Fetching target branch...');
             yield (0, utils_1.gitFetch)({
@@ -404,6 +407,7 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
                 });
             }
         }
+        core.info('Completed fetching more history.');
     }
     const currentSha = yield getCurrentSHA({ inputs, workingDirectory });
     let previousSha = inputs.baseSha;
@@ -432,26 +436,19 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
         if (inputs.sinceLastRemoteCommit) {
             previousSha = env.GITHUB_EVENT_BEFORE;
             if (!previousSha) {
-                previousSha = yield (0, utils_1.gitLsRemote)({
-                    cwd: workingDirectory,
-                    args: [currentBranch]
-                });
+                previousSha = yield (0, utils_1.getParentSha)({ cwd: workingDirectory });
             }
-            if ((yield (0, utils_1.verifyCommitSha)({
-                sha: previousSha,
-                cwd: workingDirectory,
-                showAsErrorMessage: false
-            })) !== 0) {
+            if (!previousSha) {
                 previousSha = env.GITHUB_EVENT_PULL_REQUEST_BASE_SHA;
             }
         }
         else {
-            previousSha = env.GITHUB_EVENT_PULL_REQUEST_BASE_SHA;
+            previousSha = yield (0, utils_1.getRemoteBranchHeadSha)({
+                cwd: workingDirectory,
+                branch: targetBranch
+            });
             if (!previousSha) {
-                previousSha = yield (0, utils_1.gitLsRemote)({
-                    cwd: workingDirectory,
-                    args: [targetBranch]
-                });
+                previousSha = env.GITHUB_EVENT_PULL_REQUEST_BASE_SHA;
             }
             if (isShallow) {
                 if (yield (0, utils_1.canDiffCommits)({
@@ -1168,7 +1165,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.setOutput = exports.getFilePatterns = exports.jsonOutput = exports.getDirnameMaxDepth = exports.canDiffCommits = exports.getPreviousGitTag = exports.verifyCommitSha = exports.getParentSha = exports.gitLsRemote = exports.getHeadSha = exports.gitLog = exports.gitDiff = exports.gitRenamedFiles = exports.gitSubmoduleDiffSHA = exports.getSubmodulePath = exports.gitFetchSubmodules = exports.gitFetch = exports.submoduleExists = exports.isRepoShallow = exports.updateGitGlobalConfig = exports.verifyMinimumGitVersion = void 0;
+exports.setOutput = exports.getFilePatterns = exports.jsonOutput = exports.getDirnameMaxDepth = exports.canDiffCommits = exports.getPreviousGitTag = exports.verifyCommitSha = exports.getParentSha = exports.getRemoteBranchHeadSha = exports.getHeadSha = exports.gitLog = exports.gitDiff = exports.gitRenamedFiles = exports.gitSubmoduleDiffSHA = exports.getSubmodulePath = exports.gitFetchSubmodules = exports.gitFetch = exports.submoduleExists = exports.isRepoShallow = exports.updateGitGlobalConfig = exports.verifyMinimumGitVersion = void 0;
 /*global AsyncIterableIterator*/
 const core = __importStar(__nccwpck_require__(2186));
 const exec = __importStar(__nccwpck_require__(1514));
@@ -1519,18 +1516,14 @@ const getHeadSha = ({ cwd }) => __awaiter(void 0, void 0, void 0, function* () {
     return stdout.trim();
 });
 exports.getHeadSha = getHeadSha;
-const gitLsRemote = ({ cwd, args }) => __awaiter(void 0, void 0, void 0, function* () {
-    const { stdout } = yield exec.getExecOutput('git', ['ls-remote', 'origin', ...args], {
+const getRemoteBranchHeadSha = ({ cwd, branch }) => __awaiter(void 0, void 0, void 0, function* () {
+    const { stdout } = yield exec.getExecOutput('git', ['rev-parse', `origin/${branch}`], {
         cwd,
         silent: process.env.RUNNER_DEBUG !== '1'
     });
-    const output = stdout.trim().split('\t');
-    if (output.length === 0) {
-        throw new Error('No output returned from git ls-remote');
-    }
-    return output[0];
+    return stdout.trim();
 });
-exports.gitLsRemote = gitLsRemote;
+exports.getRemoteBranchHeadSha = getRemoteBranchHeadSha;
 const getParentSha = ({ cwd }) => __awaiter(void 0, void 0, void 0, function* () {
     const { stdout, exitCode } = yield exec.getExecOutput('git', ['rev-list', '-n', '1', 'HEAD^'], {
         cwd,

package.json

@@ -37,12 +37,12 @@
     "micromatch": "^4.0.5"
   },
   "devDependencies": {
-    "@types/jest": "29.5.1",
+    "@types/jest": "29.5.2",
     "@types/micromatch": "^4.0.2",
     "@types/node": "20.2.1",
     "@types/uuid": "9.0.1",
-    "@typescript-eslint/eslint-plugin": "5.59.7",
-    "@typescript-eslint/parser": "5.59.7",
+    "@typescript-eslint/eslint-plugin": "5.59.8",
+    "@typescript-eslint/parser": "5.59.8",
     "@vercel/ncc": "0.36.1",
     "eslint": "8.41.0",
     "eslint-plugin-github": "4.7.0",

src/commitSha.ts

@@ -7,10 +7,10 @@ import {
   getHeadSha,
   getParentSha,
   getPreviousGitTag,
+  getRemoteBranchHeadSha,
   gitFetch,
   gitFetchSubmodules,
   gitLog,
-  gitLsRemote,
   verifyCommitSha
 } from './utils'
 
@@ -261,7 +261,7 @@ export const getSHAForPullRequestEvent = async (
   if (isShallow) {
     core.info('Repository is shallow, fetching more history...')
 
-    const prFetchExitCode = await gitFetch({
+    let prFetchExitCode = await gitFetch({
       cwd: workingDirectory,
       args: [
         ...gitExtraArgs,
@@ -273,7 +273,7 @@ export const getSHAForPullRequestEvent = async (
     })
 
     if (prFetchExitCode !== 0) {
-      await gitFetch({
+      prFetchExitCode = await gitFetch({
         cwd: workingDirectory,
         args: [
           ...gitExtraArgs,
@@ -286,6 +286,12 @@ export const getSHAForPullRequestEvent = async (
       })
     }
 
+    if (prFetchExitCode !== 0) {
+      throw new Error(
+        'Failed to fetch pull request branch. Please ensure "persist-credentials" is set to "true" when checking out the repository. See: https://github.com/actions/checkout#usage'
+      )
+    }
+
     if (!inputs.sinceLastRemoteCommit) {
       core.debug('Fetching target branch...')
       await gitFetch({
@@ -312,6 +318,7 @@ export const getSHAForPullRequestEvent = async (
         })
       }
     }
+    core.info('Completed fetching more history.')
   }
 
   const currentSha = await getCurrentSHA({inputs, workingDirectory})
@@ -353,29 +360,20 @@ export const getSHAForPullRequestEvent = async (
       previousSha = env.GITHUB_EVENT_BEFORE
 
       if (!previousSha) {
-        previousSha = await gitLsRemote({
-          cwd: workingDirectory,
-          args: [currentBranch]
-        })
+        previousSha = await getParentSha({cwd: workingDirectory})
       }
 
-      if (
-        (await verifyCommitSha({
-          sha: previousSha,
-          cwd: workingDirectory,
-          showAsErrorMessage: false
-        })) !== 0
-      ) {
+      if (!previousSha) {
         previousSha = env.GITHUB_EVENT_PULL_REQUEST_BASE_SHA
       }
     } else {
-      previousSha = env.GITHUB_EVENT_PULL_REQUEST_BASE_SHA
+      previousSha = await getRemoteBranchHeadSha({
+        cwd: workingDirectory,
+        branch: targetBranch
+      })
 
       if (!previousSha) {
-        previousSha = await gitLsRemote({
-          cwd: workingDirectory,
-          args: [targetBranch]
-        })
+        previousSha = env.GITHUB_EVENT_PULL_REQUEST_BASE_SHA
       }
 
       if (isShallow) {

src/utils.ts

@@ -501,28 +501,23 @@ export const getHeadSha = async ({cwd}: {cwd: string}): Promise<string> => {
   return stdout.trim()
 }
 
-export const gitLsRemote = async ({
+export const getRemoteBranchHeadSha = async ({
   cwd,
-  args
+  branch
 }: {
   cwd: string
-  args: string[]
+  branch: string
 }): Promise<string> => {
   const {stdout} = await exec.getExecOutput(
     'git',
-    ['ls-remote', 'origin', ...args],
+    ['rev-parse', `origin/${branch}`],
     {
       cwd,
       silent: process.env.RUNNER_DEBUG !== '1'
     }
   )
-  const output = stdout.trim().split('\t')
 
-  if (output.length === 0) {
-    throw new Error('No output returned from git ls-remote')
-  }
-
-  return output[0]
+  return stdout.trim()
 }
 
 export const getParentSha = async ({cwd}: {cwd: string}): Promise<string> => {

yarn.lock

@@ -738,10 +738,10 @@
   dependencies:
     "@types/istanbul-lib-report" "*"
 
-"@types/jest@29.5.1":
-  version "29.5.1"
-  resolved "https://registry.yarnpkg.com/@types/jest/-/jest-29.5.1.tgz#83c818aa9a87da27d6da85d3378e5a34d2f31a47"
-  integrity sha512-tEuVcHrpaixS36w7hpsfLBLpjtMRJUE09/MHXn923LOVojDwyC14cWcfc0rDs0VEfUyYmt/+iX1kxxp+gZMcaQ==
+"@types/jest@29.5.2":
+  version "29.5.2"
+  resolved "https://registry.yarnpkg.com/@types/jest/-/jest-29.5.2.tgz#86b4afc86e3a8f3005b297ed8a72494f89e6395b"
+  integrity sha512-mSoZVJF5YzGVCk+FsDxzDuH7s+SCkzrgKZzf0Z0T2WudhBUPoF6ktoTPC4R0ZoCPCV5xUvuU6ias5NvxcBcMMg==
   dependencies:
     expect "^29.0.0"
     pretty-format "^29.0.0"
@@ -805,7 +805,23 @@
   dependencies:
     "@types/yargs-parser" "*"
 
-"@typescript-eslint/eslint-plugin@5.59.7", "@typescript-eslint/eslint-plugin@^5.1.0":
+"@typescript-eslint/eslint-plugin@5.59.8":
+  version "5.59.8"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.59.8.tgz#1e7a3e5318ece22251dfbc5c9c6feeb4793cc509"
+  integrity sha512-JDMOmhXteJ4WVKOiHXGCoB96ADWg9q7efPWHRViT/f09bA8XOMLAVHHju3l0MkZnG1izaWXYmgvQcUjTRcpShQ==
+  dependencies:
+    "@eslint-community/regexpp" "^4.4.0"
+    "@typescript-eslint/scope-manager" "5.59.8"
+    "@typescript-eslint/type-utils" "5.59.8"
+    "@typescript-eslint/utils" "5.59.8"
+    debug "^4.3.4"
+    grapheme-splitter "^1.0.4"
+    ignore "^5.2.0"
+    natural-compare-lite "^1.4.0"
+    semver "^7.3.7"
+    tsutils "^3.21.0"
+
+"@typescript-eslint/eslint-plugin@^5.1.0":
   version "5.59.7"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.59.7.tgz#e470af414f05ecfdc05a23e9ce6ec8f91db56fe2"
   integrity sha512-BL+jYxUFIbuYwy+4fF86k5vdT9lT0CNJ6HtwrIvGh0PhH8s0yy5rjaKH2fDCrz5ITHy07WCzVGNvAmjJh4IJFA==
@@ -821,7 +837,17 @@
     semver "^7.3.7"
     tsutils "^3.21.0"
 
-"@typescript-eslint/parser@5.59.7", "@typescript-eslint/parser@^5.1.0":
+"@typescript-eslint/parser@5.59.8":
+  version "5.59.8"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-5.59.8.tgz#60cbb00671d86cf746044ab797900b1448188567"
+  integrity sha512-AnR19RjJcpjoeGojmwZtCwBX/RidqDZtzcbG3xHrmz0aHHoOcbWnpDllenRDmDvsV0RQ6+tbb09/kyc+UT9Orw==
+  dependencies:
+    "@typescript-eslint/scope-manager" "5.59.8"
+    "@typescript-eslint/types" "5.59.8"
+    "@typescript-eslint/typescript-estree" "5.59.8"
+    debug "^4.3.4"
+
+"@typescript-eslint/parser@^5.1.0":
   version "5.59.7"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-5.59.7.tgz#02682554d7c1028b89aa44a48bf598db33048caa"
   integrity sha512-VhpsIEuq/8i5SF+mPg9jSdIwgMBBp0z9XqjiEay+81PYLJuroN+ET1hM5IhkiYMJd9MkTz8iJLt7aaGAgzWUbQ==
@@ -839,6 +865,14 @@
     "@typescript-eslint/types" "5.59.7"
     "@typescript-eslint/visitor-keys" "5.59.7"
 
+"@typescript-eslint/scope-manager@5.59.8":
+  version "5.59.8"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-5.59.8.tgz#ff4ad4fec6433647b817c4a7d4b4165d18ea2fa8"
+  integrity sha512-/w08ndCYI8gxGf+9zKf1vtx/16y8MHrZs5/tnjHhMLNSixuNcJavSX4wAiPf4aS5x41Es9YPCn44MIe4cxIlig==
+  dependencies:
+    "@typescript-eslint/types" "5.59.8"
+    "@typescript-eslint/visitor-keys" "5.59.8"
+
 "@typescript-eslint/type-utils@5.59.7":
   version "5.59.7"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-5.59.7.tgz#89c97291371b59eb18a68039857c829776f1426d"
@@ -849,11 +883,26 @@
     debug "^4.3.4"
     tsutils "^3.21.0"
 
+"@typescript-eslint/type-utils@5.59.8":
+  version "5.59.8"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-5.59.8.tgz#aa6c029a9d7706d26bbd25eb4666398781df6ea2"
+  integrity sha512-+5M518uEIHFBy3FnyqZUF3BMP+AXnYn4oyH8RF012+e7/msMY98FhGL5SrN29NQ9xDgvqCgYnsOiKp1VjZ/fpA==
+  dependencies:
+    "@typescript-eslint/typescript-estree" "5.59.8"
+    "@typescript-eslint/utils" "5.59.8"
+    debug "^4.3.4"
+    tsutils "^3.21.0"
+
 "@typescript-eslint/types@5.59.7":
   version "5.59.7"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-5.59.7.tgz#6f4857203fceee91d0034ccc30512d2939000742"
   integrity sha512-UnVS2MRRg6p7xOSATscWkKjlf/NDKuqo5TdbWck6rIRZbmKpVNTLALzNvcjIfHBE7736kZOFc/4Z3VcZwuOM/A==
 
+"@typescript-eslint/types@5.59.8":
+  version "5.59.8"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-5.59.8.tgz#212e54414733618f5d0fd50b2da2717f630aebf8"
+  integrity sha512-+uWuOhBTj/L6awoWIg0BlWy0u9TyFpCHrAuQ5bNfxDaZ1Ppb3mx6tUigc74LHcbHpOHuOTOJrBoAnhdHdaea1w==
+
 "@typescript-eslint/typescript-estree@5.59.7":
   version "5.59.7"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.59.7.tgz#b887acbd4b58e654829c94860dbff4ac55c5cff8"
@@ -867,6 +916,19 @@
     semver "^7.3.7"
     tsutils "^3.21.0"
 
+"@typescript-eslint/typescript-estree@5.59.8":
+  version "5.59.8"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.59.8.tgz#801a7b1766481629481b3b0878148bd7a1f345d7"
+  integrity sha512-Jy/lPSDJGNow14vYu6IrW790p7HIf/SOV1Bb6lZ7NUkLc2iB2Z9elESmsaUtLw8kVqogSbtLH9tut5GCX1RLDg==
+  dependencies:
+    "@typescript-eslint/types" "5.59.8"
+    "@typescript-eslint/visitor-keys" "5.59.8"
+    debug "^4.3.4"
+    globby "^11.1.0"
+    is-glob "^4.0.3"
+    semver "^7.3.7"
+    tsutils "^3.21.0"
+
 "@typescript-eslint/utils@5.59.7", "@typescript-eslint/utils@^5.10.0":
   version "5.59.7"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-5.59.7.tgz#7adf068b136deae54abd9a66ba5a8780d2d0f898"
@@ -881,6 +943,20 @@
     eslint-scope "^5.1.1"
     semver "^7.3.7"
 
+"@typescript-eslint/utils@5.59.8":
+  version "5.59.8"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-5.59.8.tgz#34d129f35a2134c67fdaf024941e8f96050dca2b"
+  integrity sha512-Tr65630KysnNn9f9G7ROF3w1b5/7f6QVCJ+WK9nhIocWmx9F+TmCAcglF26Vm7z8KCTwoKcNEBZrhlklla3CKg==
+  dependencies:
+    "@eslint-community/eslint-utils" "^4.2.0"
+    "@types/json-schema" "^7.0.9"
+    "@types/semver" "^7.3.12"
+    "@typescript-eslint/scope-manager" "5.59.8"
+    "@typescript-eslint/types" "5.59.8"
+    "@typescript-eslint/typescript-estree" "5.59.8"
+    eslint-scope "^5.1.1"
+    semver "^7.3.7"
+
 "@typescript-eslint/visitor-keys@5.59.7":
   version "5.59.7"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-5.59.7.tgz#09c36eaf268086b4fbb5eb9dc5199391b6485fc5"
@@ -889,6 +965,14 @@
     "@typescript-eslint/types" "5.59.7"
     eslint-visitor-keys "^3.3.0"
 
+"@typescript-eslint/visitor-keys@5.59.8":
+  version "5.59.8"
+  resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-5.59.8.tgz#aa6a7ef862add919401470c09e1609392ef3cc40"
+  integrity sha512-pJhi2ms0x0xgloT7xYabil3SGGlojNNKjK/q6dB3Ey0uJLMjK2UDGJvHieiyJVW/7C3KI+Z4Q3pEHkm4ejA+xQ==
+  dependencies:
+    "@typescript-eslint/types" "5.59.8"
+    eslint-visitor-keys "^3.3.0"
+
 "@vercel/ncc@0.36.1":
   version "0.36.1"
   resolved "https://registry.yarnpkg.com/@vercel/ncc/-/ncc-0.36.1.tgz#d4c01fdbbe909d128d1bf11c7f8b5431654c5b95"