jenkinsci · MarkEWaite · Aug 19, 2024
@@ -36,6 +36,29 @@
  */
 public abstract class GitSCMExtension extends AbstractDescribableImpl<GitSCMExtension> {
 
+ /**
+ * When extensions created for freestyle projects have a more
+ * general purpose replacement in Pipeline, the more general
+ * purpose Pipeline step is preferred. This method allows the
+ * deprecated extension to suggest the preferred alternative.
+ *
+ * If the extension should not be used in Pipeline and there is an
+ * alternative syntax that should be used, return the alternative
+ * syntax suggestion.
+ *
+ * If the extension should not be used in Pipeline and there is no
+ * alternative syntax suggestion, return an empty string.
+ *
+ * If the extension should be used in Pipeline, return null.
+ *
+ * @return alternative syntax suggestion for Pipeline syntax to replace this extension.
+ * Null indicates the extension is intended for use in Pipeline.
+ */
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ return null;
+ }
+
  /**
  * @return <code>true</code> when this extension has a requirement to get a workspace during polling,
  * typically as it has to check for incoming changes, not just remote HEAD.
@@ -142,7 +165,7 @@
  return rev;
  }
  }
- 
+
  @Deprecated
  public Revision decorateRevisionToBuild(GitSCM scm, AbstractBuild<?,?> build, GitClient git, BuildListener listener, Revision marked, Revision rev) throws IOException, InterruptedException, GitException {
  if (Util.isOverridden(GitSCMExtension.class, getClass(), "decorateRevisionToBuild", GitSCM.class, Run.class, GitClient.class, TaskListener.class, Revision.class, Revision.class)) {
@@ -166,6 +189,15 @@
  if (build instanceof AbstractBuild && listener instanceof BuildListener) {
  beforeCheckout(scm, (AbstractBuild) build, git, (BuildListener) listener);
  }
+ String message = "***DEPRECATED*** " + getDescriptor().getDisplayName() + " is deprecated in Pipeline.";
+ String alternative = getDeprecationAlternative();
+ if (alternative != null && !(build instanceof AbstractBuild)) {
+ if (alternative.isEmpty()) {
+ listener.getLogger().println(message);
+ } else {
+ listener.getLogger().println(message + " " + getDeprecationAlternative());
+ }
+ }
  }
 
  @Deprecated

@@ -1,5 +1,6 @@
 package hudson.plugins.git.extensions.impl;
 
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import hudson.Extension;
 import hudson.model.Item;
 import hudson.plugins.git.extensions.FakeGitSCMExtension;
@@ -30,6 +31,13 @@ public BuildChooser getBuildChooser() {
  return buildChooser;
  }
 
+ @Override
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ // This extension is not intended to be used in Pipeline
+ return "Use separate Pipeline jobs for individual branches instead of switching between branches with the same job.";
+ }
+
  @Extension
  public static class DescriptorImpl extends GitSCMExtensionDescriptor {
 

@@ -1,5 +1,6 @@
 package hudson.plugins.git.extensions.impl;
 
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import hudson.Extension;
 import hudson.plugins.git.extensions.GitSCMExtension;
 import hudson.plugins.git.extensions.GitSCMExtensionDescriptor;
@@ -21,6 +22,13 @@ public boolean requiresWorkspaceForPolling() {
  return true;
  }
 
+ @Override
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ // This extension is not intended to be used in Pipeline
+ return "Use poll: false instead.";
+ }
+
  @Extension
  // No @Symbol annotation, because force polling using workspace should not be used in Pipeline
  public static class DescriptorImpl extends GitSCMExtensionDescriptor {

@@ -1,5 +1,6 @@
 package hudson.plugins.git.extensions.impl;
 
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import hudson.Extension;
 import hudson.plugins.git.extensions.FakeGitSCMExtension;
 import hudson.plugins.git.extensions.GitSCMExtensionDescriptor;
@@ -15,6 +16,14 @@
  public IgnoreNotifyCommit() {
  }
 
+ @Override
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ // This extension is not intended to be used in Pipeline
+ // No alternative is offered because notifyCommits should be ignored at a higher level in Pipeline
+ return "";
+ }
+
  /**
  * {@inheritDoc}
  */

@@ -40,6 +40,13 @@ public class MessageExclusion extends GitSCMExtension {
 
  public String getExcludedMessage() { return excludedMessage; }
 
+ @Override
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ // This extension is not intended to be used in Pipeline
+ return "Use exclusion traits in multibranch Pipelines to exclude commit messages";
+ }
+
  @Override
  @SuppressFBWarnings(value="NP_BOOLEAN_RETURN_NULL", justification="null used to indicate other extensions should decide")
  @CheckForNull

@@ -37,6 +37,13 @@ public boolean requiresWorkspaceForPolling() {
  return true;
  }
 
+ @Override
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ // This extension is not intended to be used in Pipeline
+ return "Use exclusion traits in multibranch Pipelines to exclude commit paths.";
+ }
+
  @DataBoundConstructor
  public PathRestriction(String includedRegions, String excludedRegions) {
  this.includedRegions = includedRegions;

@@ -1,5 +1,6 @@
 package hudson.plugins.git.extensions.impl;
 
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import hudson.AbortException;
 import hudson.Extension;
 import hudson.plugins.git.GitException;
@@ -137,6 +138,13 @@ public GitClientType getRequiredClient() {
  return GitClientType.GITCLI;
  }
 
+ @Override
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ // This extension is not intended to be used in Pipeline
+ return "Use shell or bat or powershell steps to implement git merge.";
+ }
+
  /**
  * {@inheritDoc}
  */

@@ -1,15 +1,19 @@
 package hudson.plugins.git.extensions.impl;
 
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import hudson.EnvVars;
 import hudson.Extension;
 import hudson.FilePath;
+import hudson.model.AbstractBuild;
 import hudson.model.Job;
+import hudson.model.Run;
 import hudson.model.TaskListener;
 import hudson.plugins.git.GitException;
 import hudson.plugins.git.GitSCM;
 import hudson.plugins.git.Messages;
 import hudson.plugins.git.extensions.GitSCMExtension;
 import hudson.plugins.git.extensions.GitSCMExtensionDescriptor;
+import org.jenkinsci.plugins.gitclient.GitClient;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 import java.io.IOException;
@@ -33,6 +37,13 @@ public String getRelativeTargetDir() {
  return relativeTargetDir;
  }
 
+ @Override
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ // This extension is not intended to be used in Pipeline
+ return "Use 'dir()' or 'ws()' to checkout into a different Pipeline workspace directory.";
+ }
+
  @Override
  public FilePath getWorkingDirectory(GitSCM scm, Job<?, ?> context, FilePath workspace, EnvVars environment, TaskListener listener) throws IOException, InterruptedException, GitException {
  if (relativeTargetDir == null || relativeTargetDir.length() == 0 || relativeTargetDir.equals(".")) {

@@ -1,5 +1,6 @@
 package hudson.plugins.git.extensions.impl;
 
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import hudson.Extension;
 import hudson.plugins.git.GitSCM;
 import hudson.plugins.git.extensions.FakeGitSCMExtension;
@@ -19,6 +20,16 @@
  this.name = name;
  }
 
+ @Override
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ // This extension is not intended to be used in Pipeline
+ // Custom SCM name should be set directly by Pipeline
+ // arguments when performing multiple checkouts in a single
+ // Pipeline.
+ return "Use the custom scm name as the userRemoteConfigs value for 'name'";
+ }
+
  public String getName() {
  return name;
  }

@@ -1,5 +1,6 @@
 package hudson.plugins.git.extensions.impl;
 
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import hudson.Extension;
 import hudson.model.Run;
 import hudson.model.TaskListener;
@@ -30,6 +31,13 @@
  git.getWorkTree().deleteContents();
  }
 
+ @Override
+ @CheckForNull
+ public String getDeprecationAlternative() {
+ // This extension is not intended to be used in Pipeline
+ return "Use cleanWs() to empty the Pipeline workspace before checkout.";
+ }
+
  /**
  * {@inheritDoc}
  */