feat: add support for specifying the max number for retries to fetch …

…missing history (#2052)

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

action.yml

@@ -227,6 +227,10 @@ inputs:
     description: "Exclude changes to submodules."
     required: false
     default: "false"
+  fetch_missing_history_max_retries:
+    description: "Maximum number of retries to fetch missing history."
+    required: false
+    default: "10"
 
 outputs:
   added_files:

src/__tests__/__snapshots__/inputs.test.ts.snap

@@ -15,6 +15,7 @@ exports[`getInputs should correctly parse boolean inputs 1`] = `
   "failOnInitialDiffError": "false",
   "failOnSubmoduleDiffError": "false",
   "fetchAdditionalSubmoduleHistory": "false",
+  "fetchMissingHistoryMaxRetries": 10,
   "files": "",
   "filesFromSourceFile": "",
   "filesFromSourceFileSeparator": "",
@@ -308,6 +309,7 @@ exports[`getInputs should return default values when no inputs are provided 1`]
   "failOnInitialDiffError": false,
   "failOnSubmoduleDiffError": false,
   "fetchAdditionalSubmoduleHistory": false,
+  "fetchMissingHistoryMaxRetries": 10,
   "files": "",
   "filesFromSourceFile": "",
   "filesFromSourceFileSeparator": "",

src/__tests__/utils.test.ts

@@ -636,7 +636,8 @@ describe('utils test', () => {
         failOnSubmoduleDiffError: false,
         negationPatternsFirst: false,
         useRestApi: false,
-        excludeSubmodules: false
+        excludeSubmodules: false,
+        fetchMissingHistoryMaxRetries: 10
       }
 
       const coreWarningSpy = jest.spyOn(core, 'warning')

src/commitSha.ts

@@ -528,7 +528,11 @@ export const getSHAForPullRequestEvent = async ({
             'Merge base is not in the local history, fetching remote target branch...'
           )
 
-          for (let i = 1; i <= 10; i++) {
+          for (
+            let i = 1;
+            i <= (inputs.fetchMissingHistoryMaxRetries || 10);
+            i++
+          ) {
             await gitFetch({
               cwd: workingDirectory,
               args: [

src/constant.ts

@@ -21,5 +21,6 @@ export const DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS: Partial<Inputs> = {
   skipInitialFetch: false,
   fetchAdditionalSubmoduleHistory: false,
   dirNamesDeletedFilesIncludeOnlyDeletedDirs: false,
-  excludeSubmodules: false
+  excludeSubmodules: false,
+  fetchMissingHistoryMaxRetries: 10
 }

src/inputs.ts

@@ -55,6 +55,7 @@ export type Inputs = {
   negationPatternsFirst: boolean
   useRestApi: boolean
   excludeSubmodules: boolean
+  fetchMissingHistoryMaxRetries?: number
 }
 
 export const getInputs = (): Inputs => {
@@ -245,6 +246,11 @@ export const getInputs = (): Inputs => {
     required: false
   })
 
+  const fetchMissingHistoryMaxRetries = core.getInput(
+    'fetch_missing_history_max_retries',
+    {required: false}
+  )
+
   const inputs: Inputs = {
     files,
     filesSeparator,
@@ -311,5 +317,12 @@ export const getInputs = (): Inputs => {
     inputs.dirNamesMaxDepth = parseInt(dirNamesMaxDepth, 10)
   }
 
+  if (fetchMissingHistoryMaxRetries) {
+    inputs.fetchMissingHistoryMaxRetries = parseInt(
+      fetchMissingHistoryMaxRetries,
+      10
+    )
+  }
+
   return inputs
 }