[JENKINS-75691] Add trait to include the ref spec of target branch of pull requests

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/trait/BitbucketBuildStatusNotificationsTrait.java

@@ -28,10 +28,8 @@
 import com.cloudbees.jenkins.plugins.bitbucket.Messages;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.Extension;
-import jenkins.scm.api.SCMSource;
 import jenkins.scm.api.trait.SCMSourceContext;
 import jenkins.scm.api.trait.SCMSourceTrait;
-import jenkins.scm.api.trait.SCMSourceTraitDescriptor;
 import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
@@ -146,7 +144,7 @@ protected void decorateContext(SCMSourceContext<?, ?> context) {
      */
     @Symbol("bitbucketBuildStatusNotifications")
     @Extension
-    public static class DescriptorImpl extends SCMSourceTraitDescriptor {
+    public static class DescriptorImpl extends BitbucketSCMSourceTraitDescriptor {
 
         /**
          * {@inheritDoc}
@@ -156,20 +154,5 @@ public String getDisplayName() {
             return Messages.BitbucketBuildStatusNotificationsTrait_displayName();
         }
 
-        /**
-         * {@inheritDoc}
-         */
-        @Override
-        public Class<? extends SCMSourceContext> getContextClass() {
-            return BitbucketSCMSourceContext.class;
-        }
-
-        /**
-         * {@inheritDoc}
-         */
-        @Override
-        public Class<? extends SCMSource> getSourceClass() {
-            return BitbucketSCMSource.class;
-        }
     }
 }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/trait/BitbucketSCMSourceTraitDescriptor.java

@@ -0,0 +1,80 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025, Falco Nikolas
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.cloudbees.jenkins.plugins.bitbucket.trait;
+
+import com.cloudbees.jenkins.plugins.bitbucket.BitbucketGitSCMBuilder;
+import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSource;
+import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSourceContext;
+import hudson.model.Descriptor;
+import hudson.plugins.git.GitSCM;
+import hudson.scm.SCM;
+import jenkins.scm.api.SCMSource;
+import jenkins.scm.api.trait.SCMBuilder;
+import jenkins.scm.api.trait.SCMSourceContext;
+import jenkins.scm.api.trait.SCMSourceTrait;
+import jenkins.scm.api.trait.SCMSourceTraitDescriptor;
+
+/**
+ * Abstract base class for {@link Descriptor} of {@link SCMSourceTrait}
+ * implementations specific for bitbucket.
+ *
+ * @since 936.3.0
+ */
+abstract class BitbucketSCMSourceTraitDescriptor extends SCMSourceTraitDescriptor {
+
+    /**
+     * {@inheritDoc}
+     */
+    @SuppressWarnings("rawtypes")
+    @Override
+    public Class<? extends SCMSourceContext> getContextClass() {
+        return BitbucketSCMSourceContext.class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Class<? extends SCMSource> getSourceClass() {
+        return BitbucketSCMSource.class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @SuppressWarnings("rawtypes")
+    @Override
+    public Class<? extends SCMBuilder> getBuilderClass() {
+        return BitbucketGitSCMBuilder.class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Class<? extends SCM> getScmClass() {
+        return GitSCM.class;
+    }
+
+}

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/trait/BranchDiscoveryTrait.java

@@ -23,7 +23,6 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket.trait;
 
-import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSource;
 import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSourceContext;
 import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSourceRequest;
 import com.cloudbees.jenkins.plugins.bitbucket.BranchSCMHead;
@@ -38,14 +37,12 @@
 import jenkins.scm.api.SCMHeadCategory;
 import jenkins.scm.api.SCMHeadOrigin;
 import jenkins.scm.api.SCMRevision;
-import jenkins.scm.api.SCMSource;
 import jenkins.scm.api.trait.SCMHeadAuthority;
 import jenkins.scm.api.trait.SCMHeadAuthorityDescriptor;
 import jenkins.scm.api.trait.SCMHeadFilter;
 import jenkins.scm.api.trait.SCMSourceContext;
 import jenkins.scm.api.trait.SCMSourceRequest;
 import jenkins.scm.api.trait.SCMSourceTrait;
-import jenkins.scm.api.trait.SCMSourceTraitDescriptor;
 import jenkins.scm.impl.trait.Discovery;
 import org.apache.commons.lang3.StringUtils;
 import org.jenkinsci.Symbol;
@@ -158,7 +155,7 @@ public boolean includeCategory(@NonNull SCMHeadCategory category) {
     @Symbol("bitbucketBranchDiscovery")
     @Extension
     @Discovery
-    public static class DescriptorImpl extends SCMSourceTraitDescriptor {
+    public static class DescriptorImpl extends BitbucketSCMSourceTraitDescriptor {
 
         /**
          * {@inheritDoc}
@@ -168,30 +165,13 @@ public String getDisplayName() {
             return Messages.BranchDiscoveryTrait_displayName();
         }
 
-        /**
-         * {@inheritDoc}
-         */
-        @Override
-        public Class<? extends SCMSourceContext> getContextClass() {
-            return BitbucketSCMSourceContext.class;
-        }
-
-        /**
-         * {@inheritDoc}
-         */
-        @Override
-        public Class<? extends SCMSource> getSourceClass() {
-            return BitbucketSCMSource.class;
-        }
-
         /**
          * Populates the strategy options.
          *
          * @return the strategy options.
          */
         @NonNull
         @Restricted(NoExternalUse.class)
-        @SuppressWarnings("unused") // stapler
         public ListBoxModel doFillStrategyIdItems() {
             ListBoxModel result = new ListBoxModel();
             result.add(Messages.BranchDiscoveryTrait_excludePRs(), "1");

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/trait/DiscardOldBranchTrait.java

@@ -23,7 +23,6 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket.trait;
 
-import com.cloudbees.jenkins.plugins.bitbucket.BitbucketGitSCMBuilder;
 import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSourceRequest;
 import com.cloudbees.jenkins.plugins.bitbucket.Messages;
 import com.cloudbees.jenkins.plugins.bitbucket.PullRequestSCMHead;
@@ -35,12 +34,10 @@
 import java.io.IOException;
 import java.time.LocalDate;
 import jenkins.scm.api.SCMHead;
-import jenkins.scm.api.trait.SCMBuilder;
 import jenkins.scm.api.trait.SCMHeadFilter;
 import jenkins.scm.api.trait.SCMSourceContext;
 import jenkins.scm.api.trait.SCMSourceRequest;
 import jenkins.scm.api.trait.SCMSourceTrait;
-import jenkins.scm.api.trait.SCMSourceTraitDescriptor;
 import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.QueryParameter;
@@ -109,11 +106,11 @@
      */
     @Symbol("bitbucketDiscardOldBranch")
     @Extension
-    public static class DescriptorImpl extends SCMSourceTraitDescriptor {
+    public static class DescriptorImpl extends BitbucketSCMSourceTraitDescriptor {
 
         public FormValidation doCheckKeepForDays(@QueryParameter final int keepForDays) {
             if (keepForDays <= 0) {
-                return FormValidation.error("Invalid value. Days must be greater than 0");
+                return FormValidation.error(Messages.DiscardOldBranchTrait_invalidDays());
             }
             return FormValidation.ok();
         }
@@ -123,13 +120,6 @@
             return Messages.DiscardOldBranchTrait_displayName();
         }
 
-        /**
-         * {@inheritDoc}
-         */
-        @Override
-        public boolean isApplicableToBuilder(@SuppressWarnings("rawtypes") @NonNull Class<? extends SCMBuilder> builderClass) {
-            return BitbucketGitSCMBuilder.class.isAssignableFrom(builderClass);
-        }
     }
 
 }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/trait/DiscardOldTagTrait.java

@@ -23,7 +23,6 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket.trait;
 
-import com.cloudbees.jenkins.plugins.bitbucket.BitbucketGitSCMBuilder;
 import com.cloudbees.jenkins.plugins.bitbucket.Messages;
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -33,11 +32,9 @@
 import jenkins.scm.api.SCMHead;
 import jenkins.scm.api.SCMSource;
 import jenkins.scm.api.mixin.TagSCMHead;
-import jenkins.scm.api.trait.SCMBuilder;
 import jenkins.scm.api.trait.SCMHeadPrefilter;
 import jenkins.scm.api.trait.SCMSourceContext;
 import jenkins.scm.api.trait.SCMSourceTrait;
-import jenkins.scm.api.trait.SCMSourceTraitDescriptor;
 import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.QueryParameter;
@@ -96,11 +93,11 @@
 
     @Symbol("bitbucketDiscardOldTag")
     @Extension
-    public static class DescriptorImpl extends SCMSourceTraitDescriptor {
+    public static class DescriptorImpl extends BitbucketSCMSourceTraitDescriptor {
 
         public FormValidation doCheckKeepForDays(@QueryParameter int keepForDays) {
             if (keepForDays <= 0) {
-                return FormValidation.error("Invalid value. Days must be greater than 0");
+                return FormValidation.error(Messages.DiscardOldTagTrait_invalidDays());
             }
             return FormValidation.ok();
         }
@@ -110,10 +107,6 @@
             return Messages.DiscardOldTagTrait_displayName();
         }
 
-        @Override
-        public boolean isApplicableToBuilder(@NonNull Class<? extends SCMBuilder> builderClass) {
-            return BitbucketGitSCMBuilder.class.isAssignableFrom(builderClass);
-        }
     }
 
 }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/trait/ForkPullRequestDiscoveryTrait.java

@@ -23,7 +23,6 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket.trait;
 
-import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSource;
 import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSourceContext;
 import com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSourceRequest;
 import com.cloudbees.jenkins.plugins.bitbucket.Messages;
@@ -39,14 +38,12 @@
 import jenkins.scm.api.SCMHeadCategory;
 import jenkins.scm.api.SCMHeadOrigin;
 import jenkins.scm.api.SCMRevision;
-import jenkins.scm.api.SCMSource;
 import jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy;
 import jenkins.scm.api.mixin.ChangeRequestSCMHead2;
 import jenkins.scm.api.trait.SCMHeadAuthority;
 import jenkins.scm.api.trait.SCMHeadAuthorityDescriptor;
 import jenkins.scm.api.trait.SCMSourceContext;
 import jenkins.scm.api.trait.SCMSourceTrait;
-import jenkins.scm.api.trait.SCMSourceTraitDescriptor;
 import jenkins.scm.impl.ChangeRequestSCMHeadCategory;
 import jenkins.scm.impl.trait.Discovery;
 import org.apache.commons.lang3.StringUtils;
@@ -166,7 +163,7 @@ public boolean includeCategory(@NonNull SCMHeadCategory category) {
     @Symbol("bitbucketForkDiscovery")
     @Extension
     @Discovery
-    public static class DescriptorImpl extends SCMSourceTraitDescriptor {
+    public static class DescriptorImpl extends BitbucketSCMSourceTraitDescriptor {
 
         /**
          * {@inheritDoc}
@@ -176,30 +173,13 @@ public String getDisplayName() {
             return Messages.ForkPullRequestDiscoveryTrait_displayName();
         }
 
-        /**
-         * {@inheritDoc}
-         */
-        @Override
-        public Class<? extends SCMSourceContext> getContextClass() {
-            return BitbucketSCMSourceContext.class;
-        }
-
-        /**
-         * {@inheritDoc}
-         */
-        @Override
-        public Class<? extends SCMSource> getSourceClass() {
-            return BitbucketSCMSource.class;
-        }
-
         /**
          * Populates the strategy options.
          *
          * @return the strategy options.
          */
         @NonNull
         @Restricted(NoExternalUse.class)
-        @SuppressWarnings("unused") // stapler
         public ListBoxModel doFillStrategyIdItems() {
             ListBoxModel result = new ListBoxModel();
             result.add(Messages.ForkPullRequestDiscoveryTrait_mergeOnly(), "1");
@@ -213,8 +193,8 @@ public ListBoxModel doFillStrategyIdItems() {
          *
          * @return the list of appropriate {@link SCMHeadAuthorityDescriptor} instances.
          */
+        @SuppressWarnings("unchecked")
         @NonNull
-        @SuppressWarnings("unused") // stapler
         public List<SCMHeadAuthorityDescriptor> getTrustDescriptors() {
             return SCMHeadAuthority._for(
                     BitbucketSCMSourceRequest.class,
@@ -230,7 +210,6 @@ public List<SCMHeadAuthorityDescriptor> getTrustDescriptors() {
          * @return the default trust for new instances of {@link ForkPullRequestDiscoveryTrait}.
          */
         @NonNull
-        @SuppressWarnings("unused") // stapler
         public SCMHeadAuthority<?, ?, ?> getDefaultTrust() {
             return new TrustTeamForks();
         }