Merge pull request #1 from stephenc/jenkins-48792

[FIXED JENKINS-48792] A branch build strategy that only builds named branches
jenkinsci · Jan 4, 2018 · 7011701 · 7011701
2 parents 4587d9c + 93a7950
commit 7011701
Show file tree

Hide file tree

Showing 29 changed files with 1,141 additions and 1 deletion.
diff --git a/CHANGES.adoc b/CHANGES.adoc
@@ -12,10 +12,14 @@ Template:
 
 ////
 
-== Version 1.0.1 (unreleased)
+== Version 1.0.2 (unreleased)
 
 * ...
 
+== Version 1.0.1 (2018-01-04)
+
+* https://issues.jenkins-ci.org/browse/JENKINS-48792[JENKINS-48792] A branch build strategy that only builds named branches.
+
 == Version 1.0.0 (2018-01-04)
 
 * Initial release
diff --git a/docs/images/named-branches-exact.png b/docs/images/named-branches-exact.png
diff --git a/docs/images/named-branches-regex.png b/docs/images/named-branches-regex.png
diff --git a/docs/images/named-branches-wildcards.png b/docs/images/named-branches-wildcards.png
diff --git a/docs/images/named-branches.png b/docs/images/named-branches.png
diff --git a/docs/user.adoc b/docs/user.adoc
@@ -21,6 +21,30 @@ image::images/branches.png[]
 This strategy will build "regular" branches (also known as streams in some source control systems).
 In otherwords, if it is not a change request and if it is not a tag, then it should be built on initial discovery and every time a revision change is detected.
 
+==== Named branches
+
+image::images/named-branches.png[]
+
+This strategy will build "regular" branches (also known as streams in some source control systems) if the name of the branch matches one of an ordered list of match rules.
+
+There name matching rules are an extension point.
+This plugin provides three implementations:
+
+Exact name::
+Matches the branch name exactly without any wildcard or special character substitution.
++
+image::images/named-branches-exact.png[]
+
+Regular expression::
+Matches the branch name against a https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[Java regular expression].
++
+image::images/named-branches-regex.png[]
+
+Wildcard include/exclude::
+Matches the branch name against pair of simple wildcard style include/exclude rules.
++
+image::images/named-branches-wildcards.png[]
+
 ==== Change requests
 
 image::images/change-requests.png[]

diff --git a/src/main/java/jenkins/branch/buildstrategies/basic/BranchBuildStrategyImpl.java b/src/main/java/jenkins/branch/buildstrategies/basic/BranchBuildStrategyImpl.java
@@ -32,6 +32,7 @@
 import jenkins.scm.api.SCMSource;
 import jenkins.scm.api.mixin.ChangeRequestSCMHead;
 import jenkins.scm.api.mixin.TagSCMHead;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -89,6 +90,7 @@ public String toString() {
     /**
      * Our descriptor.
      */
+    @Symbol("buildRegularBranches")
     @Extension
     public static class DescriptorImpl extends BranchBuildStrategyDescriptor {
         /**

diff --git a/src/main/java/jenkins/branch/buildstrategies/basic/ChangeRequestBuildStrategyImpl.java b/src/main/java/jenkins/branch/buildstrategies/basic/ChangeRequestBuildStrategyImpl.java
@@ -35,6 +35,7 @@
 import jenkins.scm.api.mixin.ChangeRequestSCMHead;
 import jenkins.scm.api.mixin.ChangeRequestSCMHead2;
 import jenkins.scm.api.mixin.ChangeRequestSCMRevision;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -119,6 +120,7 @@ public String toString() {
     /**
      * Our descriptor.
      */
+    @Symbol("buildChangeRequests")
     @Extension
     public static class DescriptorImpl extends BranchBuildStrategyDescriptor {
         /**