feat: add nested submodule recursion support

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "test/demo"]
 	path = test/demo
-	url = git@github.com:tj-actions/demo.git
+	url = git@github.com:spartan322/demo.git

action.yml

@@ -195,6 +195,10 @@ inputs:
     description: "Separator used to split the `recover_files_ignore` input"
     default: "\n"
     required: false
+  recurse_submodules:
+    description: "Recurse nested submodule changes"
+    required: false
+    default: "true"
   token:
     description: "GitHub token used to fetch changed files from Github's API."
     required: false

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

@@ -48,6 +48,7 @@ exports[`getInputs should correctly parse boolean inputs 1`] = `
 ",
   "recoverFilesSeparator": "
 ",
+  "recurseSubmodules": "false",
   "safeOutput": "false",
   "separator": "",
   "sha": "",
@@ -112,6 +113,7 @@ exports[`getInputs should correctly parse numeric inputs 1`] = `
   "recoverFilesIgnore": "",
   "recoverFilesIgnoreSeparator": "",
   "recoverFilesSeparator": "",
+  "recurseSubmodules": true,
   "safeOutput": false,
   "separator": "",
   "sha": "",
@@ -174,6 +176,7 @@ exports[`getInputs should correctly parse string inputs 1`] = `
   "recoverFilesIgnore": "",
   "recoverFilesIgnoreSeparator": "",
   "recoverFilesSeparator": "",
+  "recurseSubmodules": true,
   "safeOutput": false,
   "separator": "",
   "sha": "",
@@ -238,6 +241,7 @@ exports[`getInputs should handle invalid numeric inputs correctly 1`] = `
   "recoverFilesIgnore": "",
   "recoverFilesIgnoreSeparator": "",
   "recoverFilesSeparator": "",
+  "recurseSubmodules": true,
   "safeOutput": false,
   "separator": "",
   "sha": "",
@@ -302,6 +306,7 @@ exports[`getInputs should handle negative numeric inputs correctly 1`] = `
   "recoverFilesIgnore": "",
   "recoverFilesIgnoreSeparator": "",
   "recoverFilesSeparator": "",
+  "recurseSubmodules": true,
   "safeOutput": false,
   "separator": "",
   "sha": "",
@@ -367,6 +372,7 @@ exports[`getInputs should return default values when no inputs are provided 1`]
 ",
   "recoverFilesSeparator": "
 ",
+  "recurseSubmodules": true,
   "safeOutput": false,
   "separator": "",
   "sha": "",

src/__tests__/changedFiles.test.ts

@@ -48,6 +48,7 @@ const baseInputs: Inputs = {
   recoverFilesSeparator: '\n',
   recoverFilesIgnore: '',
   recoverFilesIgnoreSeparator: '\n',
+  recurseSubmodules: true,
   token: 'fake-token',
   apiUrl: 'https://api.github.com',
   skipInitialFetch: false,

src/__tests__/main.test.ts

@@ -97,6 +97,7 @@ jest.mock('../inputs', () => ({
     recoverFilesSeparator: '\n',
     recoverFilesIgnore: '',
     recoverFilesIgnoreSeparator: '\n',
+    recurseSubmodules: true,
     token: 'fake-token',
     apiUrl: 'https://api.github.com',
     skipInitialFetch: false,

src/__tests__/utils.test.ts

@@ -631,6 +631,7 @@ describe('utils test', () => {
         recoverFilesSeparator: '\n',
         recoverFilesIgnore: '',
         recoverFilesIgnoreSeparator: '\n',
+        recurseSubmodules: true,
         token: '${{ github.token }}',
         apiUrl: '${{ github.api_url }}',
         skipInitialFetch: false,

src/changedFiles.ts

@@ -14,6 +14,7 @@ import {
   getDirnameMaxDepth,
   getDirNamesIncludeFilesPattern,
   getFilteredChangedFiles,
+  getSubmodulePath,
   gitRenamedFiles,
   gitSubmoduleDiffSHA,
   isSymlinkInGitTree,
@@ -214,6 +215,115 @@ export type ChangedFiles = {
   [key in ChangeTypeEnum]: string[]
 }
 
+export const getAllSubmoduleDiffFiles = async ({
+  submodulePath,
+  workingDirectory,
+  previousSha,
+  currentSha,
+  diffType,
+  outputRenamedFilesAsDeletedAndAdded,
+  fetchAdditionalSubmoduleHistory,
+  failOnSubmoduleDiffError,
+  submoduleShas,
+  recurseSubmodules
+}: {
+  submodulePath: string
+  workingDirectory: string
+  previousSha: string
+  currentSha: string
+  diffType: string
+  outputRenamedFilesAsDeletedAndAdded: boolean
+  fetchAdditionalSubmoduleHistory: boolean
+  failOnSubmoduleDiffError: boolean
+  submoduleShas?: Record<string, {previousSha?: string; currentSha?: string}>
+  recurseSubmodules: boolean
+}): Promise<ChangedFiles> => {
+  const submoduleShaResult = await gitSubmoduleDiffSHA({
+    cwd: workingDirectory,
+    parentSha1: previousSha,
+    parentSha2: currentSha,
+    submodulePath,
+    diff: diffType
+  })
+
+  const submoduleWorkingDirectory = path.join(workingDirectory, submodulePath)
+
+  if (!(submoduleShaResult.currentSha && submoduleShaResult.previousSha)) {
+    return {
+      [ChangeTypeEnum.Added]: [],
+      [ChangeTypeEnum.Copied]: [],
+      [ChangeTypeEnum.Deleted]: [],
+      [ChangeTypeEnum.Modified]: [],
+      [ChangeTypeEnum.Renamed]: [],
+      [ChangeTypeEnum.TypeChanged]: [],
+      [ChangeTypeEnum.Unmerged]: [],
+      [ChangeTypeEnum.Unknown]: []
+    }
+  }
+
+  if (submoduleShas) {
+    submoduleShas[submodulePath] = submoduleShaResult
+  }
+  let diff = '...'
+
+  if (
+    !(await canDiffCommits({
+      cwd: submoduleWorkingDirectory,
+      sha1: submoduleShaResult.previousSha,
+      sha2: submoduleShaResult.currentSha,
+      diff
+    }))
+  ) {
+    let message = `Set 'fetch_additional_submodule_history: true' to fetch additional submodule history for: ${submodulePath}`
+    if (fetchAdditionalSubmoduleHistory) {
+      message = `To fetch additional submodule history for: ${submodulePath} you can increase history depth using 'fetch_depth' input`
+    }
+    core.warning(message)
+    diff = '..'
+  }
+
+  const files = await getAllChangedFiles({
+    cwd: submoduleWorkingDirectory,
+    sha1: submoduleShaResult.previousSha,
+    sha2: submoduleShaResult.currentSha,
+    diff,
+    isSubmodule: true,
+    parentDir: submodulePath,
+    outputRenamedFilesAsDeletedAndAdded,
+    failOnSubmoduleDiffError
+  })
+
+  if (!recurseSubmodules) {
+    return files
+  }
+
+  for (const innerSubmodulePath of await getSubmodulePath({
+    cwd: submoduleWorkingDirectory
+  })) {
+    const submoduleFiles = await getAllSubmoduleDiffFiles({
+      submodulePath: innerSubmodulePath,
+      workingDirectory: submoduleWorkingDirectory,
+      previousSha: submoduleShaResult.previousSha,
+      currentSha: submoduleShaResult.currentSha,
+      diffType,
+      outputRenamedFilesAsDeletedAndAdded,
+      fetchAdditionalSubmoduleHistory,
+      failOnSubmoduleDiffError,
+      submoduleShas,
+      recurseSubmodules
+    })
+
+    for (const changeType of Object.keys(submoduleFiles) as ChangeTypeEnum[]) {
+      if (!files[changeType]) {
+        files[changeType] = []
+      }
+      files[changeType].push(...submoduleFiles[changeType])
+    }
+  }
+
+  return files
+}
+
 export const getAllDiffFiles = async ({
   workingDirectory,
   diffSubmodule,
@@ -223,7 +333,8 @@ export const getAllDiffFiles = async ({
   fetchAdditionalSubmoduleHistory,
   failOnInitialDiffError,
   failOnSubmoduleDiffError,
-  submoduleShas
+  submoduleShas,
+  recurseSubmodules
 }: {
   workingDirectory: string
   diffSubmodule: boolean
@@ -234,6 +345,7 @@ export const getAllDiffFiles = async ({
   failOnInitialDiffError: boolean
   failOnSubmoduleDiffError: boolean
   submoduleShas?: Record<string, {previousSha?: string; currentSha?: string}>
+  recurseSubmodules: boolean
 }): Promise<ChangedFiles> => {
   const files = await getAllChangedFiles({
     cwd: workingDirectory,
@@ -246,60 +358,26 @@ export const getAllDiffFiles = async ({
 
   if (diffSubmodule) {
     for (const submodulePath of submodulePaths) {
-      const submoduleShaResult = await gitSubmoduleDiffSHA({
-        cwd: workingDirectory,
-        parentSha1: diffResult.previousSha,
-        parentSha2: diffResult.currentSha,
+      const submoduleFiles = await getAllSubmoduleDiffFiles({
         submodulePath,
-        diff: diffResult.diff
-      })
-
-      const submoduleWorkingDirectory = path.join(
         workingDirectory,
-        submodulePath
-      )
-
-      if (submoduleShaResult.currentSha && submoduleShaResult.previousSha) {
-        if (submoduleShas) {
-          submoduleShas[submodulePath] = submoduleShaResult
-        }
-        let diff = '...'
-
-        if (
-          !(await canDiffCommits({
-            cwd: submoduleWorkingDirectory,
-            sha1: submoduleShaResult.previousSha,
-            sha2: submoduleShaResult.currentSha,
-            diff
-          }))
-        ) {
-          let message = `Set 'fetch_additional_submodule_history: true' to fetch additional submodule history for: ${submodulePath}`
-          if (fetchAdditionalSubmoduleHistory) {
-            message = `To fetch additional submodule history for: ${submodulePath} you can increase history depth using 'fetch_depth' input`
-          }
-          core.warning(message)
-          diff = '..'
-        }
-
-        const submoduleFiles = await getAllChangedFiles({
-          cwd: submoduleWorkingDirectory,
-          sha1: submoduleShaResult.previousSha,
-          sha2: submoduleShaResult.currentSha,
-          diff,
-          isSubmodule: true,
-          parentDir: submodulePath,
-          outputRenamedFilesAsDeletedAndAdded,
-          failOnSubmoduleDiffError
-        })
+        previousSha: diffResult.previousSha,
+        currentSha: diffResult.currentSha,
+        diffType: diffResult.diff,
+        outputRenamedFilesAsDeletedAndAdded,
+        fetchAdditionalSubmoduleHistory,
+        failOnSubmoduleDiffError,
+        submoduleShas,
+        recurseSubmodules
+      })
 
-        for (const changeType of Object.keys(
-          submoduleFiles
-        ) as ChangeTypeEnum[]) {
-          if (!files[changeType]) {
-            files[changeType] = []
-          }
-          files[changeType].push(...submoduleFiles[changeType])
+      for (const changeType of Object.keys(
+        submoduleFiles
+      ) as ChangeTypeEnum[]) {
+        if (!files[changeType]) {
+          files[changeType] = []
         }
+        files[changeType].push(...submoduleFiles[changeType])
       }
     }
   }

src/constant.ts

@@ -15,6 +15,7 @@ export const DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS: Partial<Inputs> = {
   recoverFilesSeparator: '\n',
   recoverFilesIgnore: '',
   recoverFilesIgnoreSeparator: '\n',
+  recurseSubmodules: true,
   includeAllOldNewRenamedFiles: false,
   oldNewSeparator: ',',
   oldNewFilesSeparator: ' ',

src/inputs.ts

@@ -47,6 +47,7 @@ export type Inputs = {
   recoverFilesSeparator: string
   recoverFilesIgnore: string
   recoverFilesIgnoreSeparator: string
+  recurseSubmodules: boolean
   token: string
   apiUrl: string
   skipInitialFetch: boolean
@@ -206,6 +207,9 @@ export const getInputs = (): Inputs => {
       trimWhitespace: false
     }
   )
+  const recurseSubmodules = core.getBooleanInput('recurse_submodules', {
+    required: false
+  })
   const token = core.getInput('token', {required: false})
   const apiUrl = core.getInput('api_url', {required: false})
   const skipInitialFetch = core.getBooleanInput('skip_initial_fetch', {
@@ -313,6 +317,7 @@ export const getInputs = (): Inputs => {
     recoverFilesSeparator,
     recoverFilesIgnore,
     recoverFilesIgnoreSeparator,
+    recurseSubmodules,
     includeAllOldNewRenamedFiles,
     oldNewSeparator,
     oldNewFilesSeparator,

src/main.ts

@@ -188,7 +188,8 @@ const getChangedFilesFromLocalGitHistory = async ({
     fetchAdditionalSubmoduleHistory: inputs.fetchAdditionalSubmoduleHistory,
     failOnInitialDiffError: inputs.failOnInitialDiffError,
     failOnSubmoduleDiffError: inputs.failOnSubmoduleDiffError,
-    submoduleShas
+    submoduleShas,
+    recurseSubmodules: inputs.recurseSubmodules
   })
 
   if (inputs.excludeSymlinks) {