feat: add support for failing on error (#1511)

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

action.yml

@@ -188,6 +188,14 @@ inputs:
     description: "Github API URL."
     required: false
     default: ${{ github.api_url }}
+  fail_on_initial_diff_error:
+    description: "Fail when the initial diff fails."
+    required: false
+    default: "false"
+  fail_on_submodule_diff_error:
+    description: "Fail when the submodule diff fails."
+    required: false
+    default: "false"
 
 outputs:
   added_files:

dist/index.js

@@ -125,13 +125,14 @@ var ChangeTypeEnum;
     ChangeTypeEnum["Unmerged"] = "U";
     ChangeTypeEnum["Unknown"] = "X";
 })(ChangeTypeEnum || (exports.ChangeTypeEnum = ChangeTypeEnum = {}));
-const getAllDiffFiles = ({ workingDirectory, hasSubmodule, diffResult, submodulePaths, outputRenamedFilesAsDeletedAndAdded, fetchSubmoduleHistory }) => __awaiter(void 0, void 0, void 0, function* () {
+const getAllDiffFiles = ({ workingDirectory, hasSubmodule, diffResult, submodulePaths, outputRenamedFilesAsDeletedAndAdded, fetchSubmoduleHistory, failOnInitialDiffError, failOnSubmoduleDiffError }) => __awaiter(void 0, void 0, void 0, function* () {
     const files = yield (0, utils_1.getAllChangedFiles)({
         cwd: workingDirectory,
         sha1: diffResult.previousSha,
         sha2: diffResult.currentSha,
         diff: diffResult.diff,
-        outputRenamedFilesAsDeletedAndAdded
+        outputRenamedFilesAsDeletedAndAdded,
+        failOnInitialDiffError
     });
     if (hasSubmodule) {
         for (const submodulePath of submodulePaths) {
@@ -165,7 +166,8 @@ const getAllDiffFiles = ({ workingDirectory, hasSubmodule, diffResult, submodule
                     diff,
                     isSubmodule: true,
                     parentDir: submodulePath,
-                    outputRenamedFilesAsDeletedAndAdded
+                    outputRenamedFilesAsDeletedAndAdded,
+                    failOnSubmoduleDiffError
                 });
                 for (const changeType of Object.keys(submoduleFiles)) {
                     if (!files[changeType]) {
@@ -1331,6 +1333,12 @@ const getInputs = () => {
     const fetchSubmoduleHistory = core.getBooleanInput('fetch_additional_submodule_history', {
         required: false
     });
+    const failOnInitialDiffError = core.getBooleanInput('fail_on_initial_diff_error', {
+        required: false
+    });
+    const failOnSubmoduleDiffError = core.getBooleanInput('fail_on_submodule_diff_error', {
+        required: false
+    });
     const inputs = {
         files,
         filesSeparator,
@@ -1346,6 +1354,8 @@ const getInputs = () => {
         filesIgnoreYaml,
         filesIgnoreYamlFromSourceFile,
         filesIgnoreYamlFromSourceFileSeparator,
+        failOnInitialDiffError,
+        failOnSubmoduleDiffError,
         separator,
         // Not Supported via REST API
         sha,
@@ -1541,7 +1551,9 @@ const getChangedFilesFromLocalGit = ({ inputs, env, workingDirectory, filePatter
         diffResult,
         submodulePaths,
         outputRenamedFilesAsDeletedAndAdded,
-        fetchSubmoduleHistory: inputs.fetchSubmoduleHistory
+        fetchSubmoduleHistory: inputs.fetchSubmoduleHistory,
+        failOnInitialDiffError: inputs.failOnInitialDiffError,
+        failOnSubmoduleDiffError: inputs.failOnSubmoduleDiffError
     });
     core.debug(`All diff files: ${JSON.stringify(allDiffFiles)}`);
     core.info('All Done!');
@@ -2114,8 +2126,10 @@ exports.gitRenamedFiles = gitRenamedFiles;
  * @param isSubmodule - is the repo a submodule
  * @param parentDir - parent directory of the submodule
  * @param outputRenamedFilesAsDeletedAndAdded - output renamed files as deleted and added
+ * @param failOnInitialDiffError - fail if the initial diff fails
+ * @param failOnSubmoduleDiffError - fail if the submodule diff fails
  */
-const getAllChangedFiles = ({ cwd, sha1, sha2, diff, isSubmodule = false, parentDir = '', outputRenamedFilesAsDeletedAndAdded = false }) => __awaiter(void 0, void 0, void 0, function* () {
+const getAllChangedFiles = ({ cwd, sha1, sha2, diff, isSubmodule = false, parentDir = '', outputRenamedFilesAsDeletedAndAdded = false, failOnInitialDiffError = false, failOnSubmoduleDiffError = false }) => __awaiter(void 0, void 0, void 0, function* () {
     const { exitCode, stdout, stderr } = yield exec.getExecOutput('git', [
         'diff',
         '--name-status',
@@ -2137,6 +2151,14 @@ const getAllChangedFiles = ({ cwd, sha1, sha2, diff, isSubmodule = false, parent
         [changedFiles_1.ChangeTypeEnum.Unmerged]: [],
         [changedFiles_1.ChangeTypeEnum.Unknown]: []
     };
+    if (exitCode !== 0) {
+        if (failOnInitialDiffError && !isSubmodule) {
+            throw new Error(`Failed to get changed files between: ${sha1}${diff}${sha2}: ${stderr}`);
+        }
+        else if (failOnSubmoduleDiffError && isSubmodule) {
+            throw new Error(`Failed to get changed files for submodule between: ${sha1}${diff}${sha2}: ${stderr}`);
+        }
+    }
     if (exitCode !== 0) {
         if (isSubmodule) {
             core.warning(stderr ||

src/changedFiles.ts

@@ -121,7 +121,9 @@ export const getAllDiffFiles = async ({
   diffResult,
   submodulePaths,
   outputRenamedFilesAsDeletedAndAdded,
-  fetchSubmoduleHistory
+  fetchSubmoduleHistory,
+  failOnInitialDiffError,
+  failOnSubmoduleDiffError
 }: {
   workingDirectory: string
   hasSubmodule: boolean
@@ -129,13 +131,16 @@ export const getAllDiffFiles = async ({
   submodulePaths: string[]
   outputRenamedFilesAsDeletedAndAdded: boolean
   fetchSubmoduleHistory: boolean
+  failOnInitialDiffError: boolean
+  failOnSubmoduleDiffError: boolean
 }): Promise<ChangedFiles> => {
   const files = await getAllChangedFiles({
     cwd: workingDirectory,
     sha1: diffResult.previousSha,
     sha2: diffResult.currentSha,
     diff: diffResult.diff,
-    outputRenamedFilesAsDeletedAndAdded
+    outputRenamedFilesAsDeletedAndAdded,
+    failOnInitialDiffError
   })
 
   if (hasSubmodule) {
@@ -179,7 +184,8 @@ export const getAllDiffFiles = async ({
           diff,
           isSubmodule: true,
           parentDir: submodulePath,
-          outputRenamedFilesAsDeletedAndAdded
+          outputRenamedFilesAsDeletedAndAdded,
+          failOnSubmoduleDiffError
         })
 
         for (const changeType of Object.keys(

src/inputs.ts

@@ -48,6 +48,8 @@ export type Inputs = {
   token: string
   apiUrl: string
   skipInitialFetch: boolean
+  failOnInitialDiffError: boolean
+  failOnSubmoduleDiffError: boolean
 }
 
 export const getInputs = (): Inputs => {
@@ -196,6 +198,18 @@ export const getInputs = (): Inputs => {
       required: false
     }
   )
+  const failOnInitialDiffError = core.getBooleanInput(
+    'fail_on_initial_diff_error',
+    {
+      required: false
+    }
+  )
+  const failOnSubmoduleDiffError = core.getBooleanInput(
+    'fail_on_submodule_diff_error',
+    {
+      required: false
+    }
+  )
 
   const inputs: Inputs = {
     files,
@@ -212,6 +226,8 @@ export const getInputs = (): Inputs => {
     filesIgnoreYaml,
     filesIgnoreYamlFromSourceFile,
     filesIgnoreYamlFromSourceFileSeparator,
+    failOnInitialDiffError,
+    failOnSubmoduleDiffError,
     separator,
     // Not Supported via REST API
     sha,

src/main.ts

@@ -191,7 +191,9 @@ const getChangedFilesFromLocalGit = async ({
     diffResult,
     submodulePaths,
     outputRenamedFilesAsDeletedAndAdded,
-    fetchSubmoduleHistory: inputs.fetchSubmoduleHistory
+    fetchSubmoduleHistory: inputs.fetchSubmoduleHistory,
+    failOnInitialDiffError: inputs.failOnInitialDiffError,
+    failOnSubmoduleDiffError: inputs.failOnSubmoduleDiffError
   })
   core.debug(`All diff files: ${JSON.stringify(allDiffFiles)}`)
   core.info('All Done!')

src/utils.ts

@@ -490,6 +490,8 @@ export const gitRenamedFiles = async ({
  * @param isSubmodule - is the repo a submodule
  * @param parentDir - parent directory of the submodule
  * @param outputRenamedFilesAsDeletedAndAdded - output renamed files as deleted and added
+ * @param failOnInitialDiffError - fail if the initial diff fails
+ * @param failOnSubmoduleDiffError - fail if the submodule diff fails
  */
 export const getAllChangedFiles = async ({
   cwd,
@@ -498,7 +500,9 @@ export const getAllChangedFiles = async ({
   diff,
   isSubmodule = false,
   parentDir = '',
-  outputRenamedFilesAsDeletedAndAdded = false
+  outputRenamedFilesAsDeletedAndAdded = false,
+  failOnInitialDiffError = false,
+  failOnSubmoduleDiffError = false
 }: {
   cwd: string
   sha1: string
@@ -507,6 +511,8 @@ export const getAllChangedFiles = async ({
   isSubmodule?: boolean
   parentDir?: string
   outputRenamedFilesAsDeletedAndAdded?: boolean
+  failOnInitialDiffError?: boolean
+  failOnSubmoduleDiffError?: boolean
 }): Promise<ChangedFiles> => {
   const {exitCode, stdout, stderr} = await exec.getExecOutput(
     'git',
@@ -534,6 +540,18 @@ export const getAllChangedFiles = async ({
     [ChangeTypeEnum.Unknown]: []
   }
 
+  if (exitCode !== 0) {
+    if (failOnInitialDiffError && !isSubmodule) {
+      throw new Error(
+        `Failed to get changed files between: ${sha1}${diff}${sha2}: ${stderr}`
+      )
+    } else if (failOnSubmoduleDiffError && isSubmodule) {
+      throw new Error(
+        `Failed to get changed files for submodule between: ${sha1}${diff}${sha2}: ${stderr}`
+      )
+    }
+  }
+
   if (exitCode !== 0) {
     if (isSubmodule) {
       core.warning(