feat: add option to exclude submodules when detecting changes

action.yml

@@ -223,6 +223,10 @@ inputs:
     description: "Output changed files in a format that can be used for matrix jobs. Alias for setting inputs `json` to `true` and `escape_json` to `false`."
     required: false
     default: "false"
+  exclude_submodules:
+    description: "Exclude changes to submodules."
+    required: false
+    default: "false"
 
 outputs:
   added_files:

src/changedFiles.ts

@@ -121,13 +121,13 @@ export const processChangedFiles = async ({
 export const getRenamedFiles = async ({
   inputs,
   workingDirectory,
-  hasSubmodule,
+  diffSubmodule,
   diffResult,
   submodulePaths
 }: {
   inputs: Inputs
   workingDirectory: string
-  hasSubmodule: boolean
+  diffSubmodule: boolean
   diffResult: DiffResult
   submodulePaths: string[]
 }): Promise<{paths: string; count: string}> => {
@@ -139,7 +139,7 @@ export const getRenamedFiles = async ({
     oldNewSeparator: inputs.oldNewSeparator
   })
 
-  if (hasSubmodule) {
+  if (diffSubmodule) {
     for (const submodulePath of submodulePaths) {
       const submoduleShaResult = await gitSubmoduleDiffSHA({
         cwd: workingDirectory,
@@ -217,7 +217,7 @@ export type ChangedFiles = {
 
 export const getAllDiffFiles = async ({
   workingDirectory,
-  hasSubmodule,
+  diffSubmodule,
   diffResult,
   submodulePaths,
   outputRenamedFilesAsDeletedAndAdded,
@@ -226,7 +226,7 @@ export const getAllDiffFiles = async ({
   failOnSubmoduleDiffError
 }: {
   workingDirectory: string
-  hasSubmodule: boolean
+  diffSubmodule: boolean
   diffResult: DiffResult
   submodulePaths: string[]
   outputRenamedFilesAsDeletedAndAdded: boolean
@@ -243,7 +243,7 @@ export const getAllDiffFiles = async ({
     failOnInitialDiffError
   })
 
-  if (hasSubmodule) {
+  if (diffSubmodule) {
     for (const submodulePath of submodulePaths) {
       const submoduleShaResult = await gitSubmoduleDiffSHA({
         cwd: workingDirectory,

src/commitSha.ts

@@ -91,7 +91,7 @@ interface SHAForNonPullRequestEvent {
   env: Env
   workingDirectory: string
   isShallow: boolean
-  hasSubmodule: boolean
+  diffSubmodule: boolean
   gitFetchExtraArgs: string[]
   isTag: boolean
   remoteName: string
@@ -102,7 +102,7 @@ export const getSHAForNonPullRequestEvent = async ({
   env,
   workingDirectory,
   isShallow,
-  hasSubmodule,
+  diffSubmodule,
   gitFetchExtraArgs,
   isTag,
   remoteName
@@ -152,7 +152,7 @@ export const getSHAForNonPullRequestEvent = async ({
         })
       }
 
-      if (hasSubmodule) {
+      if (diffSubmodule) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [
@@ -164,7 +164,7 @@ export const getSHAForNonPullRequestEvent = async ({
         })
       }
     } else {
-      if (hasSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
+      if (diffSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [
@@ -323,7 +323,7 @@ interface SHAForPullRequestEvent {
   inputs: Inputs
   workingDirectory: string
   isShallow: boolean
-  hasSubmodule: boolean
+  diffSubmodule: boolean
   gitFetchExtraArgs: string[]
   remoteName: string
 }
@@ -332,7 +332,7 @@ export const getSHAForPullRequestEvent = async ({
   inputs,
   workingDirectory,
   isShallow,
-  hasSubmodule,
+  diffSubmodule,
   gitFetchExtraArgs,
   remoteName
 }: SHAForPullRequestEvent): Promise<DiffResult> => {
@@ -390,7 +390,7 @@ export const getSHAForPullRequestEvent = async ({
           ]
         })
 
-        if (hasSubmodule) {
+        if (diffSubmodule) {
           await gitFetchSubmodules({
             cwd: workingDirectory,
             args: [
@@ -403,7 +403,7 @@ export const getSHAForPullRequestEvent = async ({
         }
       }
     } else {
-      if (hasSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
+      if (diffSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [

src/constant.ts

@@ -20,5 +20,6 @@ export const DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS: Partial<Inputs> = {
   oldNewFilesSeparator: ' ',
   skipInitialFetch: false,
   fetchAdditionalSubmoduleHistory: false,
-  dirNamesDeletedFilesIncludeOnlyDeletedDirs: false
+  dirNamesDeletedFilesIncludeOnlyDeletedDirs: false,
+  excludeSubmodules: false
 }

src/inputs.ts

@@ -54,6 +54,7 @@ export type Inputs = {
   failOnSubmoduleDiffError: boolean
   negationPatternsFirst: boolean
   useRestApi: boolean
+  excludeSubmodules: boolean
 }
 
 export const getInputs = (): Inputs => {
@@ -240,6 +241,10 @@ export const getInputs = (): Inputs => {
     required: false
   })
 
+  const excludeSubmodules = core.getBooleanInput('exclude_submodules', {
+    required: false
+  })
+
   const inputs: Inputs = {
     files,
     filesSeparator,
@@ -279,6 +284,7 @@ export const getInputs = (): Inputs => {
     skipInitialFetch,
     fetchAdditionalSubmoduleHistory,
     dirNamesDeletedFilesIncludeOnlyDeletedDirs,
+    excludeSubmodules,
     // End Not Supported via REST API
     dirNames,
     dirNamesExcludeCurrentDir,

src/main.ts

@@ -64,10 +64,16 @@ const getChangedFilesFromLocalGitHistory = async ({
   }
 
   const isShallow = await isRepoShallow({cwd: workingDirectory})
-  const hasSubmodule = await submoduleExists({cwd: workingDirectory})
+  let diffSubmodule = false
   let gitFetchExtraArgs = ['--no-tags', '--prune']
 
-  if (hasSubmodule) {
+  if (inputs.excludeSubmodules) {
+    core.info('Excluding submodules from the diff')
+  } else {
+    diffSubmodule = await submoduleExists({cwd: workingDirectory})
+  }
+
+  if (diffSubmodule) {
     gitFetchExtraArgs.push('--recurse-submodules')
   }
 
@@ -77,7 +83,7 @@ const getChangedFilesFromLocalGitHistory = async ({
     inputs.outputRenamedFilesAsDeletedAndAdded
   let submodulePaths: string[] = []
 
-  if (hasSubmodule) {
+  if (diffSubmodule) {
     submodulePaths = await getSubmodulePath({cwd: workingDirectory})
   }
 
@@ -94,7 +100,7 @@ const getChangedFilesFromLocalGitHistory = async ({
       env,
       workingDirectory,
       isShallow,
-      hasSubmodule,
+      diffSubmodule,
       gitFetchExtraArgs,
       isTag,
       remoteName
@@ -109,7 +115,7 @@ const getChangedFilesFromLocalGitHistory = async ({
       inputs,
       workingDirectory,
       isShallow,
-      hasSubmodule,
+      diffSubmodule,
       gitFetchExtraArgs,
       remoteName
     })
@@ -127,7 +133,7 @@ const getChangedFilesFromLocalGitHistory = async ({
 
   const allDiffFiles = await getAllDiffFiles({
     workingDirectory,
-    hasSubmodule,
+    diffSubmodule,
     diffResult,
     submodulePaths,
     outputRenamedFilesAsDeletedAndAdded,
@@ -153,7 +159,7 @@ const getChangedFilesFromLocalGitHistory = async ({
       deletedFiles: allDiffFiles[ChangeTypeEnum.Deleted],
       recoverPatterns,
       diffResult,
-      hasSubmodule,
+      diffSubmodule,
       submodulePaths
     })
   }
@@ -171,7 +177,7 @@ const getChangedFilesFromLocalGitHistory = async ({
     const allOldNewRenamedFiles = await getRenamedFiles({
       inputs,
       workingDirectory,
-      hasSubmodule,
+      diffSubmodule,
       diffResult,
       submodulePaths
     })

src/utils.ts

@@ -1413,15 +1413,15 @@ export const recoverDeletedFiles = async ({
   deletedFiles,
   recoverPatterns,
   diffResult,
-  hasSubmodule,
+  diffSubmodule,
   submodulePaths
 }: {
   inputs: Inputs
   workingDirectory: string
   deletedFiles: string[]
   recoverPatterns: string[]
   diffResult: DiffResult
-  hasSubmodule: boolean
+  diffSubmodule: boolean
   submodulePaths: string[]
 }): Promise<void> => {
   let recoverableDeletedFiles = deletedFiles
@@ -1451,7 +1451,7 @@ export const recoverDeletedFiles = async ({
 
     const submodulePath = submodulePaths.find(p => deletedFile.startsWith(p))
 
-    if (hasSubmodule && submodulePath) {
+    if (diffSubmodule && submodulePath) {
       const submoduleShaResult = await gitSubmoduleDiffSHA({
         cwd: workingDirectory,
         parentSha1: diffResult.previousSha,