Skip to content

The Unified and Autonomous Development Platform

Fix issue #761 - Skip running job for branch update and pull request update trigger when commit message contains "[skip ci]" or "[ci skip]"

Robin Shen42cd6ce49f10
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/BranchUpdateTrigger.java b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/BranchUpdateTrigger.java
index 8d7964dc21..c1b687e0d0 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/BranchUpdateTrigger.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/BranchUpdateTrigger.java
@@ -20,7 +20,11 @@ import io.onedev.server.web.editable.annotation.Editable;
import io.onedev.server.web.editable.annotation.Patterns;
import io.onedev.server.web.util.SuggestionUtils;
-@Editable(order=100, name="Branch update")
+@Editable(order=100, name="Branch update", description=""
+ + "Job will run when code is committed. <b class='text-info'>NOTE:</b> This trigger will ignore commits "
+ + "with message containing <code>[skip ci]</code>, <code>[ci skip]</code>, <code>[no ci]</code>, "
+ + "<code>[skip job]</code>, <code>[job skip]</code>, or <code>[no job]</code>")
+
public class BranchUpdateTrigger extends JobTrigger {
private static final long serialVersionUID = 1L;
@@ -91,7 +95,8 @@ public class BranchUpdateTrigger extends JobTrigger {
RefUpdated refUpdated = (RefUpdated) event;
String updatedBranch = GitUtils.ref2branch(refUpdated.getRefName());
Matcher matcher = new PathMatcher();
- if (updatedBranch != null
+ if (updatedBranch != null
+ && !SKIP_COMMIT.apply(event.getProject().getRevCommit(refUpdated.getNewCommitId(), true))
&& (branches == null || PatternSet.parse(branches).matches(matcher, updatedBranch))
&& touchedFile(refUpdated)) {
return new SubmitReason() {
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/JobTrigger.java b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/JobTrigger.java
index 815883da18..cad9b6c2e6 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/JobTrigger.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/JobTrigger.java
@@ -3,11 +3,13 @@ package io.onedev.server.buildspec.job.trigger;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
+import java.util.function.Function;
import javax.annotation.Nullable;
import javax.validation.Valid;
import org.apache.wicket.Component;
+import org.eclipse.jgit.revwalk.RevCommit;
import io.onedev.commons.codeassist.InputSuggestion;
import io.onedev.server.buildspec.job.Job;
@@ -33,10 +35,21 @@ public abstract class JobTrigger implements Serializable {
private static final long serialVersionUID = 1L;
+ public static Function<RevCommit, Boolean> SKIP_COMMIT = new Function<RevCommit, Boolean>() {
+
+ @Override
+ public Boolean apply(RevCommit commit) {
+ String message = commit.getFullMessage().toLowerCase();
+ return message.contains("[skip ci]") || message.contains("[ci skip]") || message.contains("[no ci]")
+ || message.contains("[skip job]") || message.contains("[job skip]") || message.contains("[no job]");
+ }
+
+ };
+
private String projects;
private List<ParamSupply> params = new ArrayList<>();
-
+
@Editable(name="Applicable Projects", order=900, placeholder="Any project", description=""
+ "Optionally specify space-separated projects applicable for this trigger. "
+ "This is useful for instance when you want to prevent the job from being "
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/PullRequestUpdateTrigger.java b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/PullRequestUpdateTrigger.java
index 8090502293..a4a04b71f7 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/PullRequestUpdateTrigger.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/job/trigger/PullRequestUpdateTrigger.java
@@ -7,7 +7,11 @@ import io.onedev.server.event.pullrequest.PullRequestMergePreviewCalculated;
import io.onedev.server.model.PullRequest;
import io.onedev.server.web.editable.annotation.Editable;
-@Editable(order=300, name="Pull request open or update", description="Job will run on the merge commit of target branch and source branch")
+@Editable(order=300, name="Pull request open or update", description=""
+ + "Job will run on the merge commit of target branch and source branch.<br>"
+ + "<b class='text-info'>NOTE:</b> Unless required by branch protection rule, this trigger will ignore commits "
+ + "with message containing <code>[skip ci]</code>, <code>[ci skip]</code>, <code>[no ci]</code>, "
+ + "<code>[skip job]</code>, <code>[job skip]</code>, or <code>[no job]</code>")
public class PullRequestUpdateTrigger extends PullRequestTrigger {
private static final long serialVersionUID = 1L;
@@ -17,7 +21,8 @@ public class PullRequestUpdateTrigger extends PullRequestTrigger {
if (event instanceof PullRequestMergePreviewCalculated) {
PullRequestMergePreviewCalculated mergePreviewCalculated = (PullRequestMergePreviewCalculated) event;
PullRequest request = mergePreviewCalculated.getRequest();
- return triggerMatches(request);
+ if (request.getRequiredJobs().contains(job.getName()) || !SKIP_COMMIT.apply(request.getLatestUpdate().getHeadCommit()))
+ return triggerMatches(request);
}
return null;
}