Add option to disable recurse submodules

Add option to disable recurse submodules under "Provider Select the source of your code" form. * Add a checkbox to disable recurse submodules in `apps/dokploy/components/dashboard/application/general/generic/save-git-provider.tsx`, `apps/dokploy/components/dashboard/application/general/generic/save-github-provider.tsx`, and `apps/dokploy/components/dashboard/application/general/generic/save-gitlab-provider.tsx`. * Update the form schema in the above files to include the new option. * Conditionally include the `--recurse-submodules` flag in the `git clone` command in the above files. * Update the "Provider Select the source of your code" form in `apps/dokploy/components/dashboard/application/general/generic/show.tsx` to include the new option. * Conditionally include the `--recurse-submodules` flag in the `git clone` command in `packages/server/src/utils/providers/bitbucket.ts`, `packages/server/src/utils/providers/git.ts`, `packages/server/src/utils/providers/github.ts`, and `packages/server/src/utils/providers/gitlab.ts`. * Add the `--depth` flag to optimize submodule cloning performance in the `git clone` command in `packages/server/src/utils/providers/bitbucket.ts`, `packages/server/src/utils/providers/git.ts`, `packages/server/src/utils/providers/github.ts`, and `packages/server/src/utils/providers/gitlab.ts`. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Dokploy/dokploy?shareId=XXXX-XXXX-XXXX-XXXX).
2025-06-26 18:27:59 +00:00 · 2025-03-25 22:04:35 +07:00
parent e0433e9f7b
commit cc5a3e6873
7 changed files with 181 additions and 81 deletions
--- a/packages/server/src/utils/providers/bitbucket.ts
+++ b/packages/server/src/utils/providers/bitbucket.ts
@@ -37,6 +37,7 @@ export const cloneBitbucketRepository = async (
 		bitbucketBranch,
 		bitbucketId,
 		bitbucket,
+		recurseSubmodules = true,
 	} = entity;

 	if (!bitbucketId) {
@@ -53,19 +54,22 @@ export const cloneBitbucketRepository = async (
 	const cloneUrl = `https://${bitbucket?.bitbucketUsername}:${bitbucket?.appPassword}@${repoclone}`;
 	try {
 		writeStream.write(`\nCloning Repo ${repoclone} to ${outputPath}: ✅\n`);
+		const cloneArgs = [
+			"clone",
+			"--branch",
+			bitbucketBranch!,
+			"--depth",
+			"1",
+			cloneUrl,
+			outputPath,
+			"--progress",
+		];
+		if (recurseSubmodules) {
+			cloneArgs.splice(4, 0, "--recurse-submodules");
+		}
 		await spawnAsync(
 			"git",
-			[
-				"clone",
-				"--branch",
-				bitbucketBranch!,
-				"--depth",
-				"1",
-				"--recurse-submodules",
-				cloneUrl,
-				outputPath,
-				"--progress",
-			],
+			cloneArgs,
 			(data) => {
 				if (writeStream.writable) {
 					writeStream.write(data);
@@ -89,6 +93,7 @@ export const cloneRawBitbucketRepository = async (entity: Compose) => {
 		bitbucketOwner,
 		bitbucketBranch,
 		bitbucketId,
+		recurseSubmodules = true,
 	} = entity;

 	if (!bitbucketId) {
@@ -106,17 +111,20 @@ export const cloneRawBitbucketRepository = async (entity: Compose) => {
 	const cloneUrl = `https://${bitbucketProvider?.bitbucketUsername}:${bitbucketProvider?.appPassword}@${repoclone}`;

 	try {
-		await spawnAsync("git", [
+		const cloneArgs = [
 			"clone",
 			"--branch",
 			bitbucketBranch!,
 			"--depth",
 			"1",
-			"--recurse-submodules",
 			cloneUrl,
 			outputPath,
 			"--progress",
-		]);
+		];
+		if (recurseSubmodules) {
+			cloneArgs.splice(4, 0, "--recurse-submodules");
+		}
+		await spawnAsync("git", cloneArgs);
 	} catch (error) {
 		throw error;
 	}
@@ -131,6 +139,7 @@ export const cloneRawBitbucketRepositoryRemote = async (compose: Compose) => {
 		bitbucketBranch,
 		bitbucketId,
 		serverId,
+		recurseSubmodules = true,
 	} = compose;

 	if (!serverId) {
@@ -153,11 +162,11 @@ export const cloneRawBitbucketRepositoryRemote = async (compose: Compose) => {
 	const cloneUrl = `https://${bitbucketProvider?.bitbucketUsername}:${bitbucketProvider?.appPassword}@${repoclone}`;

 	try {
-		const command = `
+		const cloneCommand = `
 			rm -rf ${outputPath};
-			git clone --branch ${bitbucketBranch} --depth 1 --recurse-submodules ${cloneUrl} ${outputPath}
+			git clone --branch ${bitbucketBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
 		`;
-		await execAsyncRemote(serverId, command);
+		await execAsyncRemote(serverId, cloneCommand);
 	} catch (error) {
 		throw error;
 	}
@@ -176,6 +185,7 @@ export const getBitbucketCloneCommand = async (
 		bitbucketBranch,
 		bitbucketId,
 		serverId,
+		recurseSubmodules = true,
 	} = entity;

 	if (!serverId) {
@@ -207,7 +217,7 @@ export const getBitbucketCloneCommand = async (
 	const cloneCommand = `
 rm -rf ${outputPath};
 mkdir -p ${outputPath};
-if ! git clone --branch ${bitbucketBranch} --depth 1 --recurse-submodules --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
+if ! git clone --branch ${bitbucketBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
 	echo "❌ [ERROR] Fail to clone the repository ${repoclone}" >> ${logPath};
 	exit 1;
 fi
--- a/packages/server/src/utils/providers/git.ts
+++ b/packages/server/src/utils/providers/git.ts
@@ -17,12 +17,13 @@ export const cloneGitRepository = async (
 		customGitUrl?: string | null;
 		customGitBranch?: string | null;
 		customGitSSHKeyId?: string | null;
+		recurseSubmodules?: boolean;
 	},
 	logPath: string,
 	isCompose = false,
 ) => {
 	const { SSH_PATH, COMPOSE_PATH, APPLICATIONS_PATH } = paths();
-	const { appName, customGitUrl, customGitBranch, customGitSSHKeyId } = entity;
+	const { appName, customGitUrl, customGitBranch, customGitSSHKeyId, recurseSubmodules = true } = entity;

 	if (!customGitUrl || !customGitBranch) {
 		throw new TRPCError({
@@ -70,19 +71,22 @@ export const cloneGitRepository = async (
 		}

 		const { port } = sanitizeRepoPathSSH(customGitUrl);
+		const cloneArgs = [
+			"clone",
+			"--branch",
+			customGitBranch,
+			"--depth",
+			"1",
+			customGitUrl,
+			outputPath,
+			"--progress",
+		];
+		if (recurseSubmodules) {
+			cloneArgs.splice(4, 0, "--recurse-submodules");
+		}
 		await spawnAsync(
 			"git",
-			[
-				"clone",
-				"--branch",
-				customGitBranch,
-				"--depth",
-				"1",
-				"--recurse-submodules",
-				customGitUrl,
-				outputPath,
-				"--progress",
-			],
+			cloneArgs,
 			(data) => {
 				if (writeStream.writable) {
 					writeStream.write(data);
@@ -114,6 +118,7 @@ export const getCustomGitCloneCommand = async (
 		customGitBranch?: string | null;
 		customGitSSHKeyId?: string | null;
 		serverId: string | null;
+		recurseSubmodules?: boolean;
 	},
 	logPath: string,
 	isCompose = false,
@@ -125,6 +130,7 @@ export const getCustomGitCloneCommand = async (
 		customGitBranch,
 		customGitSSHKeyId,
 		serverId,
+		recurseSubmodules = true,
 	} = entity;

 	if (!customGitUrl || !customGitBranch) {
@@ -181,7 +187,7 @@ export const getCustomGitCloneCommand = async (
 		}

 		command.push(
-			`if ! git clone --branch ${customGitBranch} --depth 1 --recurse-submodules --progress ${customGitUrl} ${outputPath} >> ${logPath} 2>&1; then
+			`if ! git clone --branch ${customGitBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${customGitUrl} ${outputPath} >> ${logPath} 2>&1; then
 				echo "❌ [ERROR] Fail to clone the repository ${customGitUrl}" >> ${logPath};
 				exit 1;
 			fi
@@ -261,8 +267,9 @@ export const cloneGitRawRepository = async (entity: {
 	customGitUrl?: string | null;
 	customGitBranch?: string | null;
 	customGitSSHKeyId?: string | null;
+	recurseSubmodules?: boolean;
 }) => {
-	const { appName, customGitUrl, customGitBranch, customGitSSHKeyId } = entity;
+	const { appName, customGitUrl, customGitBranch, customGitSSHKeyId, recurseSubmodules = true } = entity;

 	if (!customGitUrl || !customGitBranch) {
 		throw new TRPCError({
@@ -307,19 +314,22 @@ export const cloneGitRawRepository = async (entity: {
 		}

 		const { port } = sanitizeRepoPathSSH(customGitUrl);
+		const cloneArgs = [
+			"clone",
+			"--branch",
+			customGitBranch,
+			"--depth",
+			"1",
+			customGitUrl,
+			outputPath,
+			"--progress",
+		];
+		if (recurseSubmodules) {
+			cloneArgs.splice(4, 0, "--recurse-submodules");
+		}
 		await spawnAsync(
 			"git",
-			[
-				"clone",
-				"--branch",
-				customGitBranch,
-				"--depth",
-				"1",
-				"--recurse-submodules",
-				customGitUrl,
-				outputPath,
-				"--progress",
-			],
+			cloneArgs,
 			(_data) => {},
 			{
 				env: {
@@ -342,6 +352,7 @@ export const cloneRawGitRepositoryRemote = async (compose: Compose) => {
 		customGitUrl,
 		customGitSSHKeyId,
 		serverId,
+		recurseSubmodules = true,
 	} = compose;

 	if (!serverId) {
@@ -396,7 +407,7 @@ export const cloneRawGitRepositoryRemote = async (compose: Compose) => {
 		}

 		command.push(
-			`if ! git clone --branch ${customGitBranch} --depth 1 --recurse-submodules --progress ${customGitUrl} ${outputPath} ; then
+			`if ! git clone --branch ${customGitBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${customGitUrl} ${outputPath} ; then
 				echo "[ERROR] Fail to clone the repository ";
 				exit 1;
 			fi
--- a/packages/server/src/utils/providers/github.ts
+++ b/packages/server/src/utils/providers/github.ts
@@ -83,10 +83,12 @@ interface CloneGithubRepository {
 	repository: string | null;
 	logPath: string;
 	type?: "application" | "compose";
+	recurseSubmodules?: boolean;
 }
 export const cloneGithubRepository = async ({
 	logPath,
 	type = "application",
+	recurseSubmodules = true,
 	...entity
 }: CloneGithubRepository) => {
 	const isCompose = type === "compose";
@@ -128,19 +130,22 @@ export const cloneGithubRepository = async ({

 	try {
 		writeStream.write(`\nClonning Repo ${repoclone} to ${outputPath}: ✅\n`);
+		const cloneArgs = [
+			"clone",
+			"--branch",
+			branch!,
+			"--depth",
+			"1",
+			cloneUrl,
+			outputPath,
+			"--progress",
+		];
+		if (recurseSubmodules) {
+			cloneArgs.splice(4, 0, "--recurse-submodules");
+		}
 		await spawnAsync(
 			"git",
-			[
-				"clone",
-				"--branch",
-				branch!,
-				"--depth",
-				"1",
-				"--recurse-submodules",
-				cloneUrl,
-				outputPath,
-				"--progress",
-			],
+			cloneArgs,
 			(data) => {
 				if (writeStream.writable) {
 					writeStream.write(data);
@@ -159,6 +164,7 @@ export const cloneGithubRepository = async ({
 export const getGithubCloneCommand = async ({
 	logPath,
 	type = "application",
+	recurseSubmodules = true,
 	...entity
 }: CloneGithubRepository & { serverId: string }) => {
 	const { appName, repository, owner, branch, githubId, serverId } = entity;
@@ -216,7 +222,7 @@ export const getGithubCloneCommand = async ({
 	const cloneCommand = `
 rm -rf ${outputPath};
 mkdir -p ${outputPath};
-if ! git clone --branch ${branch} --depth 1 --recurse-submodules --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
+if ! git clone --branch ${branch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
 	echo "❌ [ERROR] Fail to clone repository ${repoclone}" >> ${logPath};
 	exit 1;
 fi
@@ -227,7 +233,7 @@ echo "Cloned ${repoclone} to ${outputPath}: ✅" >> ${logPath};
 };

 export const cloneRawGithubRepository = async (entity: Compose) => {
-	const { appName, repository, owner, branch, githubId } = entity;
+	const { appName, repository, owner, branch, githubId, recurseSubmodules = true } = entity;

 	if (!githubId) {
 		throw new TRPCError({
@@ -245,24 +251,27 @@ export const cloneRawGithubRepository = async (entity: Compose) => {
 	await recreateDirectory(outputPath);
 	const cloneUrl = `https://oauth2:${token}@${repoclone}`;
 	try {
-		await spawnAsync("git", [
+		const cloneArgs = [
 			"clone",
 			"--branch",
 			branch!,
 			"--depth",
 			"1",
-			"--recurse-submodules",
 			cloneUrl,
 			outputPath,
 			"--progress",
-		]);
+		];
+		if (recurseSubmodules) {
+			cloneArgs.splice(4, 0, "--recurse-submodules");
+		}
+		await spawnAsync("git", cloneArgs);
 	} catch (error) {
 		throw error;
 	}
 };

 export const cloneRawGithubRepositoryRemote = async (compose: Compose) => {
-	const { appName, repository, owner, branch, githubId, serverId } = compose;
+	const { appName, repository, owner, branch, githubId, serverId, recurseSubmodules = true } = compose;

 	if (!serverId) {
 		throw new TRPCError({
@@ -288,7 +297,7 @@ export const cloneRawGithubRepositoryRemote = async (compose: Compose) => {
 	try {
 		const command = `
 			rm -rf ${outputPath};
-			git clone --branch ${branch} --depth 1 ${cloneUrl} ${outputPath}
+			git clone --branch ${branch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
 		`;
 		await execAsyncRemote(serverId, command);
 	} catch (error) {
--- a/packages/server/src/utils/providers/gitlab.ts
+++ b/packages/server/src/utils/providers/gitlab.ts
@@ -90,7 +90,7 @@ export const cloneGitlabRepository = async (
 	isCompose = false,
 ) => {
 	const writeStream = createWriteStream(logPath, { flags: "a" });
-	const { appName, gitlabBranch, gitlabId, gitlab, gitlabPathNamespace } =
+	const { appName, gitlabBranch, gitlabId, gitlab, gitlabPathNamespace, recurseSubmodules = true } =
 		entity;

 	if (!gitlabId) {
@@ -127,19 +127,22 @@ export const cloneGitlabRepository = async (

 	try {
 		writeStream.write(`\nClonning Repo ${repoclone} to ${outputPath}: ✅\n`);
+		const cloneArgs = [
+			"clone",
+			"--branch",
+			gitlabBranch!,
+			"--depth",
+			"1",
+			cloneUrl,
+			outputPath,
+			"--progress",
+		];
+		if (recurseSubmodules) {
+			cloneArgs.splice(4, 0, "--recurse-submodules");
+		}
 		await spawnAsync(
 			"git",
-			[
-				"clone",
-				"--branch",
-				gitlabBranch!,
-				"--depth",
-				"1",
-				"--recurse-submodules",
-				cloneUrl,
-				outputPath,
-				"--progress",
-			],
+			cloneArgs,
 			(data) => {
 				if (writeStream.writable) {
 					writeStream.write(data);
@@ -167,6 +170,7 @@ export const getGitlabCloneCommand = async (
 		gitlabId,
 		serverId,
 		gitlab,
+		recurseSubmodules = true,
 	} = entity;

 	if (!serverId) {
@@ -222,7 +226,7 @@ export const getGitlabCloneCommand = async (
 	const cloneCommand = `
 rm -rf ${outputPath};
 mkdir -p ${outputPath};
-if ! git clone --branch ${gitlabBranch} --depth 1 --recurse-submodules --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
+if ! git clone --branch ${gitlabBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
 	echo "❌ [ERROR] Fail to clone the repository ${repoclone}" >> ${logPath};
 	exit 1;
 fi
@@ -326,7 +330,7 @@ export const getGitlabBranches = async (input: {
 };

 export const cloneRawGitlabRepository = async (entity: Compose) => {
-	const { appName, gitlabBranch, gitlabId, gitlabPathNamespace } = entity;
+	const { appName, gitlabBranch, gitlabId, gitlabPathNamespace, recurseSubmodules = true } = entity;

 	if (!gitlabId) {
 		throw new TRPCError({
@@ -347,24 +351,27 @@ export const cloneRawGitlabRepository = async (entity: Compose) => {
 	const cloneUrl = `https://oauth2:${gitlabProvider?.accessToken}@${repoclone}`;

 	try {
-		await spawnAsync("git", [
+		const cloneArgs = [
 			"clone",
 			"--branch",
 			gitlabBranch!,
 			"--depth",
 			"1",
-			"--recurse-submodules",
 			cloneUrl,
 			outputPath,
 			"--progress",
-		]);
+		];
+		if (recurseSubmodules) {
+			cloneArgs.splice(4, 0, "--recurse-submodules");
+		}
+		await spawnAsync("git", cloneArgs);
 	} catch (error) {
 		throw error;
 	}
 };

 export const cloneRawGitlabRepositoryRemote = async (compose: Compose) => {
-	const { appName, gitlabPathNamespace, branch, gitlabId, serverId } = compose;
+	const { appName, gitlabPathNamespace, branch, gitlabId, serverId, recurseSubmodules = true } = compose;

 	if (!serverId) {
 		throw new TRPCError({
@@ -388,7 +395,7 @@ export const cloneRawGitlabRepositoryRemote = async (compose: Compose) => {
 	try {
 		const command = `
 			rm -rf ${outputPath};
-			git clone --branch ${branch} --depth 1 --recurse-submodules ${cloneUrl} ${outputPath}
+			git clone --branch ${branch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
 		`;
 		await execAsyncRemote(serverId, command);
 	} catch (error) {