The Unified and Autonomous Development Platform
chore: Refactored create branch step
Robin Shend749374d7142
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java b/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.javaindex a7874d225b..5cc802f846 100644--- a/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java+++ b/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java@@ -2583,6 +2583,41 @@ public class BuildSpec implements Serializable, Validatable {|| "PullImageStep".equals(stepType)|| "RenovateStep".equals(stepType)) {migrate47_setDefaultRunAs(stepNode);+ } else if ("CreateBranchStep".equals(stepType)) {+ String branchName = null;+ for (var itStepTuple = stepNode.getValue().iterator(); itStepTuple.hasNext();) {+ var stepTuple = itStepTuple.next();+ var propName = ((ScalarNode) stepTuple.getKeyNode()).getValue();+ if (propName.equals("branchName")) {+ branchName = ((ScalarNode) stepTuple.getValueNode()).getValue();+ itStepTuple.remove();+ break;+ }+ }+ Preconditions.checkNotNull(branchName);+ List<NodeTuple> providerTuples = new ArrayList<>();+ var suggestedIssueBranchIndex = branchName.indexOf("@suggested_issue_branch@");+ if (suggestedIssueBranchIndex != -1) {+ providerTuples.add(new NodeTuple(+ new ScalarNode(Tag.STR, "type"),+ new ScalarNode(Tag.STR, "GeneratedBranchName")));+ if (suggestedIssueBranchIndex > 0) {+ var prefix = branchName.substring(0, suggestedIssueBranchIndex);+ providerTuples.add(new NodeTuple(+ new ScalarNode(Tag.STR, "prefix"),+ new ScalarNode(Tag.STR, prefix)));+ }+ } else {+ providerTuples.add(new NodeTuple(+ new ScalarNode(Tag.STR, "type"),+ new ScalarNode(Tag.STR, "SpecifiedBranchName")));+ providerTuples.add(new NodeTuple(+ new ScalarNode(Tag.STR, "name"),+ new ScalarNode(Tag.STR, branchName)));+ }+ stepNode.getValue().add(new NodeTuple(+ new ScalarNode(Tag.STR, "branchNameProvider"),+ new MappingNode(Tag.MAP, providerTuples, FlowStyle.BLOCK)));}}});diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/JobVariable.java b/server-core/src/main/java/io/onedev/server/buildspec/job/JobVariable.javaindex 5ddaf6a98b..659be6f2c7 100644--- a/server-core/src/main/java/io/onedev/server/buildspec/job/JobVariable.java+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/JobVariable.java@@ -6,11 +6,9 @@ import static io.onedev.k8shelper.KubernetesHelper.PLACEHOLDER_SUFFIX;import java.net.MalformedURLException;import java.net.URL;-import io.onedev.commons.utils.ExplicitException;import io.onedev.k8shelper.KubernetesHelper;import io.onedev.server.OneDev;import io.onedev.server.model.Build;-import io.onedev.server.service.IssueService;import io.onedev.server.service.SettingService;import io.onedev.server.util.UrlUtils;@@ -117,15 +115,6 @@ public enum JobVariable {return null;}},- SUGGESTED_ISSUE_BRANCH {- @Override- public String getValue(Build build) {- if (build.getIssue() != null)- return OneDev.getInstance(IssueService.class).suggestBranch(build.getIssue());- else- throw new ExplicitException("Suggested issue branch is only available for issue state triggers");- }- },SERVER {@Overridepublic String getValue(Build build) {diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/CreateBranchStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/CreateBranchStep.javaindex 0b156e5968..5755a873ec 100644--- a/server-core/src/main/java/io/onedev/server/buildspec/step/CreateBranchStep.java+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/CreateBranchStep.java@@ -1,51 +1,54 @@package io.onedev.server.buildspec.step;+import java.io.File;+import java.util.ArrayList;+import java.util.List;+import java.util.stream.Collectors;++import javax.validation.constraints.NotEmpty;+import javax.validation.constraints.NotNull;++import org.eclipse.jgit.lib.Repository;+import io.onedev.commons.codeassist.InputSuggestion;import io.onedev.commons.utils.ExplicitException;+import io.onedev.commons.utils.StringUtils;import io.onedev.commons.utils.TaskLogger;import io.onedev.k8shelper.ServerStepResult;import io.onedev.server.OneDev;-import io.onedev.server.annotation.BranchName;import io.onedev.server.annotation.ChoiceProvider;import io.onedev.server.annotation.Editable;import io.onedev.server.annotation.Interpolative;import io.onedev.server.buildspec.BuildSpec;-import io.onedev.server.service.BuildService;+import io.onedev.server.buildspec.step.branchnameprovider.BranchNameProvider;+import io.onedev.server.buildspec.step.branchnameprovider.GeneratedBranchName;import io.onedev.server.git.GitUtils;import io.onedev.server.git.service.GitService;import io.onedev.server.git.service.RefFacade;import io.onedev.server.model.Project;import io.onedev.server.persistence.SessionService;+import io.onedev.server.service.BuildService;import io.onedev.server.web.util.SuggestionUtils;-import org.eclipse.jgit.lib.Repository;--import javax.validation.constraints.NotEmpty;-import java.io.File;-import java.util.ArrayList;-import java.util.List;-import java.util.stream.Collectors;@Editable(name="Create Branch", order=280)public class CreateBranchStep extends ServerSideStep {private static final long serialVersionUID = 1L;- private String branchName;+ private BranchNameProvider branchNameProvider = new GeneratedBranchName();private String branchRevision;private String accessTokenSecret;- @Editable(order=1000, description="Specify name of the branch")- @Interpolative(variableSuggester="suggestVariables")- @BranchName- @NotEmpty- public String getBranchName() {- return branchName;+ @Editable(order=1000, name="Branch Name")+ @NotNull+ public BranchNameProvider getBranchNameProvider() {+ return branchNameProvider;}- public void setBranchName(String branchName) {- this.branchName = branchName;+ public void setBranchNameProvider(BranchNameProvider branchNameProvider) {+ this.branchNameProvider = branchNameProvider;}@Editable(order=1100, placeholder = "Build Commit", description="Optionally specify revision " +@@ -96,8 +99,10 @@ public class CreateBranchStep extends ServerSideStep {return OneDev.getInstance(SessionService.class).call(() -> {var build = OneDev.getInstance(BuildService.class).load(buildId);Project project = build.getProject();- String branchName = getBranchName();+ String branchName = branchNameProvider.getBranchName(build);+ if (StringUtils.isBlank(branchName))+ throw new ExplicitException("Branch name should not be empty");if (!Repository.isValidRefName(GitUtils.branch2ref(branchName)))throw new ExplicitException("Invalid branch name: " + branchName);diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/branchnameprovider/BranchNameProvider.java b/server-core/src/main/java/io/onedev/server/buildspec/step/branchnameprovider/BranchNameProvider.javanew file mode 100644index 0000000000..7033004f79--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/branchnameprovider/BranchNameProvider.java@@ -0,0 +1,13 @@+package io.onedev.server.buildspec.step.branchnameprovider;++import java.io.Serializable;++import io.onedev.server.annotation.Editable;+import io.onedev.server.model.Build;++@Editable+public interface BranchNameProvider extends Serializable {++ String getBranchName(Build build);++}diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/branchnameprovider/GeneratedBranchName.java b/server-core/src/main/java/io/onedev/server/buildspec/step/branchnameprovider/GeneratedBranchName.javanew file mode 100644index 0000000000..7c05c14ec6--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/branchnameprovider/GeneratedBranchName.java@@ -0,0 +1,50 @@+package io.onedev.server.buildspec.step.branchnameprovider;++import java.util.List;++import io.onedev.commons.codeassist.InputSuggestion;+import io.onedev.commons.utils.ExplicitException;+import io.onedev.server.OneDev;+import io.onedev.server.annotation.Editable;+import io.onedev.server.annotation.Interpolative;+import io.onedev.server.buildspec.BuildSpec;+import io.onedev.server.model.Build;+import io.onedev.server.service.IssueService;++@Editable(order=100, name="Use generated branch name", description="""+ Generate branch name based on issue title. It is highly recommended to configure+ AI model in <i>Administration / AI Settings</i> to generate good branch name""")+public class GeneratedBranchName implements BranchNameProvider {++ private static final long serialVersionUID = 1L;++ private String prefix;++ @Editable(order=100, name="Branch Prefix", placeholder = "No prefix", description="Optionally specify a prefix to be prepended to generated branch name")+ @Interpolative(variableSuggester="suggestVariables")+ public String getPrefix() {+ return prefix;+ }++ public void setPrefix(String prefix) {+ this.prefix = prefix;+ }++ @Override+ public String getBranchName(Build build) {+ if (build.getIssue() != null) {+ var branchName = OneDev.getInstance(IssueService.class).suggestBranch(build.getIssue());+ if (prefix != null)+ branchName = prefix + branchName;+ return branchName;+ } else {+ throw new ExplicitException("Generated branch name is only available when issue state triggers are used");+ }+ }++ @SuppressWarnings("unused")+ private static List<InputSuggestion> suggestVariables(String matchWith) {+ return BuildSpec.suggestVariables(matchWith, true, true, false);+ }++}diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/branchnameprovider/SpecifiedBranchName.java b/server-core/src/main/java/io/onedev/server/buildspec/step/branchnameprovider/SpecifiedBranchName.javanew file mode 100644index 0000000000..ab6b179150--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/branchnameprovider/SpecifiedBranchName.java@@ -0,0 +1,43 @@+package io.onedev.server.buildspec.step.branchnameprovider;++import java.util.List;++import javax.validation.constraints.NotEmpty;++import io.onedev.commons.codeassist.InputSuggestion;+import io.onedev.server.annotation.BranchName;+import io.onedev.server.annotation.Editable;+import io.onedev.server.annotation.Interpolative;+import io.onedev.server.buildspec.BuildSpec;+import io.onedev.server.model.Build;++@Editable(order=200, name="Use specified branch name")+public class SpecifiedBranchName implements BranchNameProvider {++ private static final long serialVersionUID = 1L;++ private String name;++ @Editable(order=100, description="Specify name of the branch")+ @Interpolative(variableSuggester="suggestVariables")+ @BranchName+ @NotEmpty+ public String getName() {+ return name;+ }++ public void setName(String name) {+ this.name = name;+ }++ @Override+ public String getBranchName(Build build) {+ return getName();+ }++ @SuppressWarnings("unused")+ private static List<InputSuggestion> suggestVariables(String matchWith) {+ return BuildSpec.suggestVariables(matchWith, true, true, false);+ }++}diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/pullrequesttitleanddescriptionprovider/GeneratedPullRequestTitleAndDescription.java b/server-core/src/main/java/io/onedev/server/buildspec/step/pullrequesttitleanddescriptionprovider/GeneratedPullRequestTitleAndDescription.javaindex 311e992b80..dbdd5f1064 100644--- a/server-core/src/main/java/io/onedev/server/buildspec/step/pullrequesttitleanddescriptionprovider/GeneratedPullRequestTitleAndDescription.java+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/pullrequesttitleanddescriptionprovider/GeneratedPullRequestTitleAndDescription.java@@ -9,11 +9,14 @@ import io.onedev.server.model.PullRequest;import io.onedev.server.service.PullRequestService;import io.onedev.server.service.SettingService;-@Editable(order=100, name="Use generated title and description")+@Editable(order=100, name="Use generated title and description", description="""+ Generate title and description based on branch name and commit messages.+ It is highly recommended to configure AI model in <i>Administration / AI Settings</i>+ to generate good title and description""")public class GeneratedPullRequestTitleAndDescription implements PullRequestTitleAndDescriptionProvider {@Override- public Pair<String, String> getTitleAndDescription(PullRequest pullRequest) {+ public Pair<String, String> getTitleAndDescription(PullRequest pullRequest) {var title = pullRequest.generateTitleFromCommits();var description = pullRequest.generateDescriptionFromCommits();if (title == null || description == null) {diff --git a/server-core/src/main/java/io/onedev/server/service/impl/DefaultIssueService.java b/server-core/src/main/java/io/onedev/server/service/impl/DefaultIssueService.javaindex 562fb58ca0..c916e1f9ac 100644--- a/server-core/src/main/java/io/onedev/server/service/impl/DefaultIssueService.java+++ b/server-core/src/main/java/io/onedev/server/service/impl/DefaultIssueService.java@@ -1334,7 +1334,7 @@ public class DefaultIssueService extends BaseEntityService<Issue> implements Issvar systemMessage = new SystemMessage("""Convert the given title into a short slug for a git branch name.Rules: use only lowercase letters (for non-english title, translate to english first), numbers and hyphens; no spaces or other special characters;- replace spaces with single hyphens; output only the slug, nothing else; maximum 50 characters.""");+ replace spaces with single hyphens; output only the slug, nothing else; maximum 30 characters.""");for (int attempt = 0; attempt < 3; attempt++) {try {var userMessage = new UserMessage(issue.getTitle());