New major version to remove legacy features (#304)

* New major version

* remove deprecations introduced in 2.0

* Update Jenkins baseline and BOM version in pom.xml

Author: strangelookingnerd

README.adoc

@@ -24,6 +24,10 @@ Since version 1.10 release notes are recorded in https://github.com/jenkinsci/ba
 
 Changelogs for older releases can be found in the link:https://github.com/jenkinsci/badge-plugin/blob/fa18486e5f1f21f8f3eb7fe3a8e6088647e84ab3/CHANGELOG.adoc[archive].
 
+=== Version 3.x
+
+Version 3.0 removes legacy features introduced in <<Version 2.x>> and therefore breaks compatibility in case the legacy features where not migrated before upgrading the plugin. More details on this can be found in the https://github.com/jenkinsci/badge-plugin/releases/tag/badge-3.0[Release Notes for 3.0].
+
 === Version 2.x
 
 Version 2.0 is a major rework of the original plugin and introduces lots of new features.

pom.xml

@@ -34,11 +34,11 @@
   <properties>
     <changelist>-SNAPSHOT</changelist>
     <gitHubRepo>jenkinsci/badge-plugin</gitHubRepo>
-    <hpi.compatibleSinceVersion>2.0</hpi.compatibleSinceVersion>
+    <hpi.compatibleSinceVersion>3.0</hpi.compatibleSinceVersion>
     <!-- https://www.jenkins.io/doc/developer/plugin-development/choosing-jenkins-baseline/ -->
-    <jenkins.baseline>2.516</jenkins.baseline>
+    <jenkins.baseline>2.541</jenkins.baseline>
     <jenkins.version>${jenkins.baseline}.3</jenkins.version>
-    <revision>2</revision>
+    <revision>3</revision>
     <changelist>999999-SNAPSHOT</changelist>
     <spotless.check.skip>false</spotless.check.skip>
     <ban-junit4-imports.skip>false</ban-junit4-imports.skip>
@@ -50,18 +50,14 @@
       <dependency>
         <groupId>io.jenkins.tools.bom</groupId>
         <artifactId>bom-${jenkins.baseline}.x</artifactId>
-        <version>6098.v29a_dff8a_0c19</version>
+        <version>6146.vc53a_0edb_e986</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>
 
   <dependencies>
-    <dependency>
-      <groupId>io.jenkins.plugins</groupId>
-      <artifactId>commons-text-api</artifactId>
-    </dependency>
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
       <artifactId>emoji-symbols-api</artifactId>

src/main/java/com/jenkinsci/plugins/badge/action/AbstractBadgeAction.java

@@ -38,8 +38,6 @@
 import java.util.logging.Logger;
 import jenkins.model.Jenkins;
 import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted;
-import org.kohsuke.accmod.Restricted;
-import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.kohsuke.stapler.export.Exported;
 import org.kohsuke.stapler.export.ExportedBean;
 
@@ -74,7 +72,7 @@ public abstract class AbstractBadgeAction implements Action, Serializable {
      *
      * @deprecated Use {@link AbstractBadgeAction#AbstractBadgeAction(String, String, String, String, String, String, String)} instead.
      */
-    @Deprecated(since = "2.8")
+    @Deprecated(since = "2.8", forRemoval = true)
     protected AbstractBadgeAction(String id, String icon, String text, String cssClass, String style, String link) {
         this(id, icon, text, cssClass, style, link, null);
     }
@@ -123,7 +121,7 @@ public String getIcon() {
             return icon;
         }
 
-        // backwards compatible replacement for old GIFs
+        // backwards compatible replacement for old GIFs - since 2.8
         return switch (icon) {
             case "completed.gif" -> "symbol-status-blue";
             case "db_in.gif" -> Ionicons.getIconClassName("cloud-upload-outline");
@@ -248,101 +246,4 @@ public String getIconFileName() {
     public String getUrlName() {
         return "";
     }
-
-    // LEGACY CODE
-    @Deprecated(since = "2.0", forRemoval = true)
-    private transient String iconPath;
-
-    @Deprecated(since = "2.0", forRemoval = true)
-    private transient String color;
-
-    @Deprecated(since = "2.0", forRemoval = true)
-    private transient String background;
-
-    @Deprecated(since = "2.0", forRemoval = true)
-    private transient String border;
-
-    @Deprecated(since = "2.0", forRemoval = true)
-    private transient String borderColor;
-
-    /**
-     * @deprecated kept for backwards compatibility.
-     * Translates pre 2.0 build.xml to latest format for backwards compatibility.
-     * @return this instance
-     */
-    @Serial
-    @Deprecated(since = "2.0", forRemoval = true)
-    protected Object readResolve() {
-        // field renamed - see AbstractBadgeAction
-        if (iconPath != null) {
-            setIcon(iconPath);
-        }
-
-        // field reworked - see AddShortTextStep
-        String style = "";
-        if (border != null) {
-            style += "border: " + border + " solid " + (borderColor != null ? borderColor : "") + ";";
-        }
-        if (background != null) {
-            style += "background: " + background + ";";
-        }
-        if (color != null) {
-            if (color.startsWith("jenkins-!-color")) {
-                style += "color: var(--" + color.replaceFirst("jenkins-!-color-", "") + ");";
-            } else if (color.startsWith("jenkins-!-")) {
-                style += "color: var(--" + color.replaceFirst("jenkins-!-", "") + ");";
-            } else {
-                style += "color: " + getJenkinsColorStyle(color) + ";";
-            }
-        }
-        if (!style.isEmpty()) {
-            setStyle(style);
-        }
-
-        return this;
-    }
-
-    /**
-     * Get the Jenkins color style for the given color reference. Returns {@code color} if the color is not a
-     * known Jenkins palette color or semantic color.
-     * @param color color reference
-     * @return jenkins color style variable
-     */
-    @NonNull
-    @Restricted(NoExternalUse.class)
-    public static String getJenkinsColorStyle(@NonNull String color) {
-        String primary = color;
-        if (color.startsWith("light-") && color.length() > 6) {
-            primary = color.substring(6);
-        } else if (color.startsWith("dark-") && color.length() > 5) {
-            primary = color.substring(5);
-        }
-        // spotless:off
-        // https://github.com/jenkinsci/jenkins/blob/master/src/main/scss/abstracts/_theme.scss
-        return switch (primary) {
-            case "blue",
-                 "brown",
-                 "cyan",
-                 "green",
-                 "indigo",
-                 "orange",
-                 "pink",
-                 "purple",
-                 "red",
-                 "yellow",
-                 "white",
-                 "black" -> "var(--" + color + ")"; // palette
-            case "accent",
-                 "text",
-                 "error",
-                 "warning",
-                 "success",
-                 "destructive",
-                 "build",
-                 "danger",
-                 "info" -> "var(--" + color + "-color)"; // semantics
-            default -> color;
-        };
-        // spotless:on
-    }
 }

src/main/java/com/jenkinsci/plugins/badge/action/BadgeAction.java

@@ -37,7 +37,7 @@ public class BadgeAction extends AbstractBadgeAction implements BuildBadgeAction
     /**
      * @deprecated Use {@link BadgeAction#BadgeAction(String, String, String, String, String, String, String)} instead.
      */
-    @Deprecated(since = "2.8")
+    @Deprecated(since = "2.8", forRemoval = true)
     public BadgeAction(String id, String icon, String text, String cssClass, String style, String link) {
         super(id, icon, text, cssClass, style, link);
     }

src/main/java/com/jenkinsci/plugins/badge/action/BadgeSummaryAction.java

@@ -24,9 +24,6 @@
 package com.jenkinsci.plugins.badge.action;
 
 import java.io.Serial;
-import java.util.Objects;
-import org.apache.commons.text.StringEscapeUtils;
-import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted;
 
 /**
  * Common action for build summaries.
@@ -39,7 +36,7 @@ public class BadgeSummaryAction extends AbstractBadgeAction {
     /**
      * @deprecated Use {@link BadgeSummaryAction#BadgeSummaryAction(String, String, String, String, String, String, String)} instead.
      */
-    @Deprecated(since = "2.8")
+    @Deprecated(since = "2.8", forRemoval = true)
     public BadgeSummaryAction(String id, String icon, String text, String cssClass, String style, String link) {
         super(id, icon, text, cssClass, style, link);
     }
@@ -53,65 +50,4 @@ public BadgeSummaryAction(
     public String getDisplayName() {
         return "Badge Summary Action";
     }
-
-    @Whitelisted
-    @Deprecated(since = "2.0", forRemoval = true)
-    public void appendText(String text) {
-        appendText(text, false);
-    }
-
-    @Whitelisted
-    @Deprecated(since = "2.0", forRemoval = true)
-    public void appendText(String text, boolean escapeHtml) {
-        if (escapeHtml) {
-            text = StringEscapeUtils.escapeHtml4(text);
-        }
-        setText(Objects.requireNonNullElse(getText(), "") + text);
-    }
-
-    @Whitelisted
-    @Deprecated(since = "2.0", forRemoval = true)
-    public void appendText(String text, boolean escapeHtml, boolean bold, boolean italic, String color) {
-        String startTags = "";
-        String closeTags = "";
-        if (bold) {
-            startTags += "<b>";
-            closeTags += "</b>";
-        }
-        if (italic) {
-            startTags += "<i>";
-            closeTags += "</i>";
-        }
-        if (color != null) {
-            startTags += "<font color=\"" + StringEscapeUtils.escapeHtml4(color) + "\">";
-            closeTags += "</font>";
-        }
-        if (escapeHtml) {
-            text = StringEscapeUtils.escapeHtml4(text);
-        }
-        setText(Objects.requireNonNullElse(getText(), "") + startTags + text + closeTags);
-    }
-
-    // LEGACY CODE
-    @Deprecated(since = "2.0", forRemoval = true)
-    private transient String summaryText;
-
-    /**
-     * @deprecated kept for backwards compatibility.
-     * Translates pre 2.0 build.xml to latest format for backwards compatibility.
-     * @return this instance
-     */
-    @Serial
-    @Override
-    @Deprecated(since = "2.0", forRemoval = true)
-    protected Object readResolve() {
-        super.readResolve();
-
-        // field renamed
-        if (summaryText != null) {
-            setText(summaryText);
-        }
-
-        return this;
-    }
 }