Skip to content

The Unified and Autonomous Development Platform

Fix issue #656 - Able to checkout repository to specified sub directory under job workspace

Robin Shenc9c7ce5b9f07
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/CheckoutStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/CheckoutStep.java
index db5deabad5..fa8688f35b 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/CheckoutStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/CheckoutStep.java
@@ -1,14 +1,19 @@
package io.onedev.server.buildspec.step;
+import java.util.List;
+
import javax.validation.constraints.NotNull;
+import io.onedev.commons.codeassist.InputSuggestion;
import io.onedev.k8shelper.CheckoutFacade;
import io.onedev.k8shelper.StepFacade;
+import io.onedev.server.buildspec.BuildSpec;
import io.onedev.server.buildspec.job.gitcredential.DefaultCredential;
import io.onedev.server.buildspec.job.gitcredential.GitCredential;
import io.onedev.server.buildspec.param.ParamCombination;
import io.onedev.server.model.Build;
import io.onedev.server.web.editable.annotation.Editable;
+import io.onedev.server.web.editable.annotation.Interpolative;
@Editable(order=50, name="Checkout Code")
public class CheckoutStep extends Step {
@@ -23,6 +28,8 @@ public class CheckoutStep extends Step {
private Integer cloneDepth;
+ private String checkoutPath;
+
@Editable(order=100, description="By default code is cloned via an auto-generated credential, "
+ "which only has read permission over current project. In case the job needs to <a href='$docRoot/pages/push-in-job.md' target='_blank'>push code to server</a>, or want "
+ "to <a href='$docRoot/pages/clone-submodules-via-ssh.md' target='_blank'>clone private submodules</a>, you should supply custom credential with appropriate permissions here")
@@ -63,10 +70,26 @@ public class CheckoutStep extends Step {
this.cloneDepth = cloneDepth;
}
+ @Editable(order=300, placeholder="Job workspace", description="Optionally specify path relative to "
+ + "job workspace to clone code into. Leave empty to use job workspace itself")
+ @Interpolative(variableSuggester="suggestVariables")
+ public String getCheckoutPath() {
+ return checkoutPath;
+ }
+
+ public void setCheckoutPath(String checkoutPath) {
+ this.checkoutPath = checkoutPath;
+ }
+
+ @SuppressWarnings("unused")
+ private static List<InputSuggestion> suggestVariables(String matchWith) {
+ return BuildSpec.suggestVariables(matchWith, false, false);
+ }
+
@Override
public StepFacade getFacade(Build build, String jobToken, ParamCombination paramCombination) {
return new CheckoutFacade(cloneDepth!=null?cloneDepth:0, withLfs, withSubmodules,
- cloneCredential.newCloneInfo(build, jobToken));
+ cloneCredential.newCloneInfo(build, jobToken), checkoutPath);
}
}
diff --git a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
index be666eb6ca..f5120d9915 100644
--- a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
+++ b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
@@ -329,7 +329,9 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
if (hostAuthInfoHome.get() == null)
hostAuthInfoHome.set(FileUtils.createTempDir());
Commandline git = new Commandline(AppLoader.getInstance(GitConfig.class).getExecutable());
- git.workingDir(hostWorkspace).environments().put("HOME", hostAuthInfoHome.get().getAbsolutePath());
+
+ checkoutFacade.setupWorkingDir(git, hostWorkspace, hostCacheHome, cacheAllocations);
+ git.environments().put("HOME", hostAuthInfoHome.get().getAbsolutePath());
CloneInfo cloneInfo = checkoutFacade.getCloneInfo();
diff --git a/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java b/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java
index 80ab123268..6c396b6b07 100644
--- a/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java
+++ b/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java
@@ -195,7 +195,9 @@ public class ServerShellExecutor extends JobExecutor implements Testable<TestDat
CheckoutFacade checkoutFacade = (CheckoutFacade) facade;
jobLogger.log("Checking out code...");
Commandline git = new Commandline(AppLoader.getInstance(GitConfig.class).getExecutable());
- git.workingDir(workspaceDir);
+
+ checkoutFacade.setupWorkingDir(git, workspaceDir, cacheHomeDir, cacheAllocations);
+
Map<String, String> environments = new HashMap<>();
environments.put("HOME", userDir.getAbsolutePath());
git.environments(environments);