Add githubPullRequests.ignoreSubmodules setting to filter submodules from PR management (#7624)

* Initial plan

* Add ignoreSubmodules setting and implementation

* Add gitignore entry for manual test files

* Add unit tests for isSubmodule function

* Polish

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Alex Ross <38270282+alexr00@users.noreply.github.com>

Author: Copilot

package.json

@@ -410,6 +410,11 @@
 					},
 					"description": "%githubPullRequests.ignoredPullRequestBranches.description%"
 				},
+				"githubPullRequests.ignoreSubmodules": {
+					"type": "boolean",
+					"default": false,
+					"description": "%githubPullRequests.ignoreSubmodules.description%"
+				},
 				"githubPullRequests.neverIgnoreDefaultBranch": {
 					"type": "boolean",
 					"description": "%githubPullRequests.neverIgnoreDefaultBranch.description%"

package.nls.json

@@ -67,6 +67,7 @@
 	"githubPullRequests.allowFetch.description": "Allows `git fetch` to be run for checked-out pull request branches when checking for updates to the pull request.",
 	"githubPullRequests.ignoredPullRequestBranches.description": "Prevents branches that are associated with a pull request from being automatically detected. This will prevent review mode from being entered on these branches.",
 	"githubPullRequests.ignoredPullRequestBranches.items": "Branch name",
+	"githubPullRequests.ignoreSubmodules.description": "Prevents repositories that are submodules from being managed by the GitHub Pull Requests extension.",
 	"githubPullRequests.neverIgnoreDefaultBranch.description": "Never offer to ignore a pull request associated with the default branch of a repository.",
 	"githubPullRequests.overrideDefaultBranch.description": "The default branch for a repository is set on github.com. With this setting, you can override that default with another branch.",
 	"githubPullRequests.postCreate.description": "The action to take after creating a pull request.",

src/common/gitUtils.ts

@@ -0,0 +1,34 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import { Repository } from '../api/api';
+import { GitApiImpl } from '../api/api1';
+
+/**
+ * Determines if a repository is a submodule by checking if its path
+ * appears in any other repository's submodules list.
+ */
+export function isSubmodule(repo: Repository, git: GitApiImpl): boolean {
+	const repoPath = repo.rootUri.fsPath;
+
+	// Check all other repositories to see if this repo is listed as a submodule
+	for (const otherRepo of git.repositories) {
+		if (otherRepo.rootUri.toString() === repo.rootUri.toString()) {
+			continue; // Skip self
+		}
+
+		// Check if this repo's path appears in the other repo's submodules
+		for (const submodule of otherRepo.state.submodules) {
+			// The submodule path is relative to the parent repo, so we need to resolve it
+			const submodulePath = vscode.Uri.joinPath(otherRepo.rootUri, submodule.path).fsPath;
+			if (submodulePath === repoPath) {
+				return true;
+			}
+		}
+	}
+
+	return false;
+}

src/common/settingKeys.ts

@@ -11,6 +11,7 @@ export const FILE_LIST_LAYOUT = 'fileListLayout';
 export const ASSIGN_TO = 'assignCreated';
 export const PUSH_BRANCH = 'pushBranch';
 export const IGNORE_PR_BRANCHES = 'ignoredPullRequestBranches';
+export const IGNORE_SUBMODULES = 'ignoreSubmodules';
 export const NEVER_IGNORE_DEFAULT_BRANCH = 'neverIgnoreDefaultBranch';
 export const OVERRIDE_DEFAULT_BRANCH = 'overrideDefaultBranch';
 export const PULL_BRANCH = 'pullBranch';

src/extension.ts

@@ -12,11 +12,12 @@ import { GitApiImpl } from './api/api1';
 import { registerCommands } from './commands';
 import { COPILOT_SWE_AGENT } from './common/copilot';
 import { commands } from './common/executeCommands';
+import { isSubmodule } from './common/gitUtils';
 import Logger from './common/logger';
 import * as PersistentState from './common/persistentState';
 import { parseRepositoryRemotes } from './common/remote';
 import { Resource } from './common/resources';
-import { BRANCH_PUBLISH, EXPERIMENTAL_CHAT, FILE_LIST_LAYOUT, GIT, OPEN_DIFF_ON_CLICK, PR_SETTINGS_NAMESPACE, SHOW_INLINE_OPEN_FILE_ACTION } from './common/settingKeys';
+import { BRANCH_PUBLISH, EXPERIMENTAL_CHAT, FILE_LIST_LAYOUT, GIT, IGNORE_SUBMODULES, OPEN_DIFF_ON_CLICK, PR_SETTINGS_NAMESPACE, SHOW_INLINE_OPEN_FILE_ACTION } from './common/settingKeys';
 import { initBasedOnSettingChange } from './common/settingsUtils';
 import { TemporaryState } from './common/temporaryState';
 import { Schemes } from './common/uri';
@@ -185,6 +186,14 @@ async function init(
 				Logger.appendLine(`Repo ${repo.rootUri} has already been setup.`, ACTIVATION);
 				return;
 			}
+
+			// Check if submodules should be ignored
+			const ignoreSubmodules = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<boolean>(IGNORE_SUBMODULES, false);
+			if (ignoreSubmodules && isSubmodule(repo, git)) {
+				Logger.appendLine(`Repo ${repo.rootUri} is a submodule and will be ignored due to ${IGNORE_SUBMODULES} setting.`, ACTIVATION);
+				return;
+			}
+
 			const newFolderManager = new FolderRepositoryManager(reposManager.folderManagers.length, context, repo, telemetry, git, credentialStore, createPrHelper, themeWatcher);
 			reposManager.insertFolderManager(newFolderManager);
 			const newReviewManager = new ReviewManager(

src/test/extension.isSubmodule.test.ts

@@ -0,0 +1,121 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { default as assert } from 'assert';
+import * as vscode from 'vscode';
+import { Repository, Submodule } from '../api/api';
+import { GitApiImpl } from '../api/api1';
+import { isSubmodule } from '../common/gitUtils'
+
+describe('isSubmodule Tests', function () {
+	it('should return false for repositories with no submodules', () => {
+		const mockRepo: Repository = {
+			rootUri: vscode.Uri.file('/home/user/repo1'),
+			state: {
+				submodules: [],
+				remotes: [],
+				HEAD: undefined,
+				rebaseCommit: undefined,
+				mergeChanges: [],
+				indexChanges: [],
+				workingTreeChanges: [],
+				onDidChange: new vscode.EventEmitter<void>().event,
+			},
+		} as Partial<Repository> as Repository;
+
+		const mockGit: GitApiImpl = {
+			repositories: [mockRepo],
+		} as GitApiImpl;
+
+		const result = isSubmodule(mockRepo, mockGit);
+		assert.strictEqual(result, false);
+	});
+
+	it('should return true when repository is listed as submodule in another repo', () => {
+		const submoduleRepo: Repository = {
+			rootUri: vscode.Uri.file('/home/user/parent/submodule'),
+			state: {
+				submodules: [],
+				remotes: [],
+				HEAD: undefined,
+				rebaseCommit: undefined,
+				mergeChanges: [],
+				indexChanges: [],
+				workingTreeChanges: [],
+				onDidChange: new vscode.EventEmitter<void>().event,
+			},
+		} as Partial<Repository> as Repository;
+
+		const parentRepo: Repository = {
+			rootUri: vscode.Uri.file('/home/user/parent'),
+			state: {
+				submodules: [
+					{
+						name: 'submodule',
+						path: 'submodule',
+						url: 'https://github.com/example/submodule.git'
+					} as Submodule
+				],
+				remotes: [],
+				HEAD: undefined,
+				rebaseCommit: undefined,
+				mergeChanges: [],
+				indexChanges: [],
+				workingTreeChanges: [],
+				onDidChange: new vscode.EventEmitter<void>().event,
+			},
+		} as Partial<Repository> as Repository;
+
+		const mockGit: GitApiImpl = {
+			repositories: [parentRepo, submoduleRepo],
+		} as GitApiImpl;
+
+		const result = isSubmodule(submoduleRepo, mockGit);
+		assert.strictEqual(result, true);
+	});
+
+	it('should return false when repository is not listed as submodule', () => {
+		const repo1: Repository = {
+			rootUri: vscode.Uri.file('/home/user/repo1'),
+			state: {
+				submodules: [],
+				remotes: [],
+				HEAD: undefined,
+				rebaseCommit: undefined,
+				mergeChanges: [],
+				indexChanges: [],
+				workingTreeChanges: [],
+				onDidChange: new vscode.EventEmitter<void>().event,
+			},
+		} as Partial<Repository> as Repository;
+
+		const repo2: Repository = {
+			rootUri: vscode.Uri.file('/home/user/repo2'),
+			state: {
+				submodules: [
+					{
+						name: 'different-submodule',
+						path: 'different-submodule',
+						url: 'https://github.com/example/different.git'
+					} as Submodule
+				],
+				remotes: [],
+				HEAD: undefined,
+				rebaseCommit: undefined,
+				mergeChanges: [],
+				indexChanges: [],
+				workingTreeChanges: [],
+				onDidChange: new vscode.EventEmitter<void>().event,
+			},
+		} as Partial<Repository> as Repository;
+
+		const mockGit: GitApiImpl = {
+			repositories: [repo1, repo2],
+		} as GitApiImpl;
+
+		const result = isSubmodule(repo1, mockGit);
+		assert.strictEqual(result, false);
+	});
+});