feat: add dir_names_exclude_current_dir input and cleaned up logic to retrieve the current sha (#1229)

Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: tj-actions[bot] <109116665+tj-actions-bot@users.noreply.github.com>
Co-authored-by: jackton1 <jackton1@users.noreply.github.com>

action.yml

@@ -79,15 +79,20 @@ inputs:
     default: "true"
   dir_names:
     default: "false"
-    description: "Output unique changed directories instead of filenames. **NOTE:** This returns `.` for changed files located in the root of the project."
+    description: "Output unique changed directories instead of filenames. **NOTE:** This returns `.` for changed files located in the current working directory which defaults to `$GITHUB_WORKSPACE`."
     required: false
   dir_names_max_depth:
     description: "Limit the directory output to a maximum depth e.g `test/test1/test2` with max depth of `2` returns `test/test1`."
     required: false
+  dir_names_exclude_current_dir:
+    description: "Exclude the current directory represented by `.` from the output when `dir_names` is set to `true`."
+    required: false
+    default: "false"
   dir_names_exclude_root:
     description: "Exclude the root directory represented by `.` from the output when `dir_names`is set to `true`."
     required: false
     default: "false"
+    deprecationMessage: "This input is deprecated. Use `dir_names_exclude_current_dir` instead."
   json:
     description: "Output list of changed files in a JSON formatted string which can be used for matrix jobs."
     required: false

dist/index.js

@@ -118,7 +118,7 @@ const getDiffFiles = ({ inputs, workingDirectory, hasSubmodule, diffResult, diff
         files = files.map(file => (0, utils_1.getDirnameMaxDepth)({
             pathStr: file,
             dirNamesMaxDepth: inputs.dirNamesMaxDepth,
-            excludeRoot: inputs.dirNamesExcludeRoot
+            excludeCurrentDir: inputs.dirNamesExcludeRoot || inputs.dirNamesExcludeCurrentDir
         }));
         files = [...new Set(files)];
     }
@@ -173,7 +173,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.getSHAForPullRequestEvent = exports.getSHAForPushEvent = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const utils_1 = __nccwpck_require__(918);
-const getCurrentSHA = ({ inputs, workingDirectory }) => __awaiter(void 0, void 0, void 0, function* () {
+const getCurrentSHA = ({ env, inputs, workingDirectory }) => __awaiter(void 0, void 0, void 0, function* () {
     let currentSha = inputs.sha;
     core.debug('Getting current SHA...');
     if (inputs.until) {
@@ -199,9 +199,19 @@ const getCurrentSHA = ({ inputs, workingDirectory }) => __awaiter(void 0, void 0
     }
     else {
         if (!currentSha) {
+            if (env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA &&
+                (yield (0, utils_1.verifyCommitSha)({
+                    sha: env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA,
+                    cwd: workingDirectory,
+                    showAsErrorMessage: false
+                })) === 0) {
+                currentSha = env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA;
+            }
+            else {
                 currentSha = yield (0, utils_1.getHeadSha)({ cwd: workingDirectory });
             }
         }
+    }
     yield (0, utils_1.verifyCommitSha)({ sha: currentSha, cwd: workingDirectory });
     core.debug(`Current SHA: ${currentSha}`);
     return currentSha;
@@ -252,7 +262,7 @@ const getSHAForPushEvent = (inputs, env, workingDirectory, isShallow, hasSubmodu
             });
         }
     }
-    const currentSha = yield getCurrentSHA({ inputs, workingDirectory });
+    const currentSha = yield getCurrentSHA({ env, inputs, workingDirectory });
     let previousSha = inputs.baseSha;
     const diff = '..';
     if (previousSha && currentSha && currentBranch && targetBranch) {
@@ -409,7 +419,7 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
         }
         core.info('Completed fetching more history.');
     }
-    let currentSha = yield getCurrentSHA({ inputs, workingDirectory });
+    const currentSha = yield getCurrentSHA({ env, inputs, workingDirectory });
     let previousSha = inputs.baseSha;
     let diff = '...';
     if (previousSha && currentSha && currentBranch && targetBranch) {
@@ -418,7 +428,7 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
             core.error(`Please verify that both commits are valid, and increase the fetch_depth to a number higher than ${inputs.fetchDepth}.`);
             throw new Error('Similar commit hashes detected.');
         }
-        yield (0, utils_1.verifyCommitSha)({ sha: currentSha, cwd: workingDirectory });
+        yield (0, utils_1.verifyCommitSha)({ sha: previousSha, cwd: workingDirectory });
         core.debug(`Previous SHA: ${previousSha}`);
         return {
             previousSha,
@@ -485,9 +495,6 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
             previousSha = env.GITHUB_EVENT_PULL_REQUEST_BASE_SHA;
         }
     }
-    if (previousSha === currentSha && env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA) {
-        currentSha = env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA;
-    }
     if (!(yield (0, utils_1.canDiffCommits)({
         cwd: workingDirectory,
         sha1: previousSha,
@@ -676,6 +683,9 @@ const getInputs = () => {
     const dirNamesExcludeRoot = core.getBooleanInput('dir_names_exclude_root', {
         required: false
     });
+    const dirNamesExcludeCurrentDir = core.getBooleanInput('dir_names_exclude_current_dir', {
+        required: false
+    });
     const json = core.getBooleanInput('json', { required: false });
     const escapeJson = core.getBooleanInput('escape_json', { required: false });
     const fetchDepth = core.getInput('fetch_depth', { required: false });
@@ -706,6 +716,7 @@ const getInputs = () => {
         diffRelative,
         dirNames,
         dirNamesExcludeRoot,
+        dirNamesExcludeCurrentDir,
         json,
         escapeJson,
         sinceLastRemoteCommit,
@@ -1579,14 +1590,14 @@ const canDiffCommits = ({ cwd, sha1, sha2, diff }) => __awaiter(void 0, void 0,
     return true;
 });
 exports.canDiffCommits = canDiffCommits;
-const getDirnameMaxDepth = ({ pathStr, dirNamesMaxDepth, excludeRoot }) => {
+const getDirnameMaxDepth = ({ pathStr, dirNamesMaxDepth, excludeCurrentDir }) => {
     const pathArr = dirname(pathStr).split(path.sep);
     const maxDepth = Math.min(dirNamesMaxDepth || pathArr.length, pathArr.length);
     let output = pathArr[0];
     for (let i = 1; i < maxDepth; i++) {
         output = path.join(output, pathArr[i]);
     }
-    if (excludeRoot && output === '.') {
+    if (excludeCurrentDir && output === '.') {
         return '';
     }
     return normalizePath(output);

src/changedFiles.ts

@@ -130,7 +130,8 @@ export const getDiffFiles = async ({
       getDirnameMaxDepth({
         pathStr: file,
         dirNamesMaxDepth: inputs.dirNamesMaxDepth,
-        excludeRoot: inputs.dirNamesExcludeRoot
+        excludeCurrentDir:
+          inputs.dirNamesExcludeRoot || inputs.dirNamesExcludeCurrentDir
       })
     )
     files = [...new Set(files)]

src/commitSha.ts

@@ -15,9 +15,11 @@ import {
 } from './utils'
 
 const getCurrentSHA = async ({
+  env,
   inputs,
   workingDirectory
 }: {
+  env: Env
   inputs: Inputs
   workingDirectory: string
 }): Promise<string> => {
@@ -47,9 +49,20 @@ const getCurrentSHA = async ({
     }
   } else {
     if (!currentSha) {
+      if (
+        env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA &&
+        (await verifyCommitSha({
+          sha: env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA,
+          cwd: workingDirectory,
+          showAsErrorMessage: false
+        })) === 0
+      ) {
+        currentSha = env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA
+      } else {
         currentSha = await getHeadSha({cwd: workingDirectory})
       }
     }
+  }
 
   await verifyCommitSha({sha: currentSha, cwd: workingDirectory})
   core.debug(`Current SHA: ${currentSha}`)
@@ -124,7 +137,7 @@ export const getSHAForPushEvent = async (
     }
   }
 
-  const currentSha = await getCurrentSHA({inputs, workingDirectory})
+  const currentSha = await getCurrentSHA({env, inputs, workingDirectory})
   let previousSha = inputs.baseSha
   const diff = '..'
 
@@ -321,7 +334,7 @@ export const getSHAForPullRequestEvent = async (
     core.info('Completed fetching more history.')
   }
 
-  let currentSha = await getCurrentSHA({inputs, workingDirectory})
+  const currentSha = await getCurrentSHA({env, inputs, workingDirectory})
   let previousSha = inputs.baseSha
   let diff = '...'
 
@@ -336,7 +349,7 @@ export const getSHAForPullRequestEvent = async (
       throw new Error('Similar commit hashes detected.')
     }
 
-    await verifyCommitSha({sha: currentSha, cwd: workingDirectory})
+    await verifyCommitSha({sha: previousSha, cwd: workingDirectory})
     core.debug(`Previous SHA: ${previousSha}`)
 
     return {
@@ -425,10 +438,6 @@ export const getSHAForPullRequestEvent = async (
     }
   }
 
-  if (previousSha === currentSha && env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA) {
-    currentSha = env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA
-  }
-
   if (
     !(await canDiffCommits({
       cwd: workingDirectory,

src/inputs.ts

@@ -23,6 +23,7 @@ export type Inputs = {
   dirNames: boolean
   dirNamesMaxDepth?: number
   dirNamesExcludeRoot: boolean
+  dirNamesExcludeCurrentDir: boolean
   json: boolean
   escapeJson: boolean
   fetchDepth?: number
@@ -93,6 +94,12 @@ export const getInputs = (): Inputs => {
   const dirNamesExcludeRoot = core.getBooleanInput('dir_names_exclude_root', {
     required: false
   })
+  const dirNamesExcludeCurrentDir = core.getBooleanInput(
+    'dir_names_exclude_current_dir',
+    {
+      required: false
+    }
+  )
   const json = core.getBooleanInput('json', {required: false})
   const escapeJson = core.getBooleanInput('escape_json', {required: false})
   const fetchDepth = core.getInput('fetch_depth', {required: false})
@@ -127,6 +134,7 @@ export const getInputs = (): Inputs => {
     diffRelative,
     dirNames,
     dirNamesExcludeRoot,
+    dirNamesExcludeCurrentDir,
     json,
     escapeJson,
     sinceLastRemoteCommit,

src/utils.ts

@@ -642,11 +642,11 @@ export const canDiffCommits = async ({
 export const getDirnameMaxDepth = ({
   pathStr,
   dirNamesMaxDepth,
-  excludeRoot
+  excludeCurrentDir
 }: {
   pathStr: string
   dirNamesMaxDepth?: number
-  excludeRoot?: boolean
+  excludeCurrentDir?: boolean
 }): string => {
   const pathArr = dirname(pathStr).split(path.sep)
   const maxDepth = Math.min(dirNamesMaxDepth || pathArr.length, pathArr.length)
@@ -656,7 +656,7 @@ export const getDirnameMaxDepth = ({
     output = path.join(output, pathArr[i])
   }
 
-  if (excludeRoot && output === '.') {
+  if (excludeCurrentDir && output === '.') {
     return ''
   }