Remove readme generator

jenkinsci · May 11, 2024 · e11d1ca · e11d1ca
1 parent 784a2ea
commit e11d1ca
Show file tree

Hide file tree

Showing 16 changed files with 64 additions and 640 deletions.
diff --git a/pom.xml b/pom.xml
@@ -56,36 +56,6 @@
         <tag>${scmTag}</tag>
     </scm>
 
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <configuration>
-                    <compilerArgument>-Xlint:all</compilerArgument>
-                </configuration>
-            </plugin>
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>exec-maven-plugin</artifactId>
-                <version>3.2.0</version>
-                <executions>
-                    <execution>
-                        <goals>
-                            <goal>java</goal>
-                        </goals>
-                        <phase>prepare-package</phase>
-                        <configuration>
-                            <includeProjectDependencies>true</includeProjectDependencies>
-                            <classpathScope>test</classpathScope>
-                            <mainClass>com.jenkinsci.plugins.badge.readme.ReadmeGenerator</mainClass>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
-        </plugins>
-    </build>
-
     <repositories>
         <repository>
             <id>repo.jenkins-ci.org</id>
@@ -115,7 +85,6 @@
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-step-api</artifactId>
         </dependency>
-
         <dependency>
             <groupId>org.jenkins-ci.plugins</groupId>
             <artifactId>structs</artifactId>
@@ -124,7 +93,6 @@
             <groupId>org.jenkins-ci.plugins</groupId>
             <artifactId>script-security</artifactId>
         </dependency>
-
         <dependency>
             <groupId>org.jenkins-ci.plugins</groupId>
             <artifactId>antisamy-markup-formatter</artifactId>
@@ -133,16 +101,6 @@
             <groupId>io.jenkins.plugins</groupId>
             <artifactId>ionicons-api</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.jenkins-ci.plugins</groupId>
-            <artifactId>jackson2-api</artifactId>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>io.jenkins.plugins</groupId>
-            <artifactId>commons-lang3-api</artifactId>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-cps</artifactId>
@@ -164,30 +122,5 @@
             <artifactId>workflow-job</artifactId>
             <scope>test</scope>
         </dependency>
-
-        <dependency>
-            <groupId>com.hubspot.jinjava</groupId>
-            <artifactId>jinjava</artifactId>
-            <version>2.7.2</version>
-            <scope>test</scope>
-            <exclusions>
-                <exclusion>
-                    <groupId>commons-net</groupId>
-                    <artifactId>commons-net</artifactId>
-                </exclusion>
-                <exclusion>
-                    <groupId>org.apache.commons</groupId>
-                    <artifactId>commons-lang3</artifactId>
-                </exclusion>
-                <exclusion>
-                    <groupId>com.fasterxml.jackson.core</groupId>
-                    <artifactId>*</artifactId>
-                </exclusion>
-                <exclusion>
-                    <groupId>com.fasterxml.jackson.dataformat</groupId>
-                    <artifactId>*</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
     </dependencies>
 </project>
diff --git a/src/main/java/com/jenkinsci/plugins/badge/annotations/OptionalParam.java b/src/main/java/com/jenkinsci/plugins/badge/annotations/OptionalParam.java
diff --git a/src/main/java/com/jenkinsci/plugins/badge/annotations/Param.java b/src/main/java/com/jenkinsci/plugins/badge/annotations/Param.java
diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/AbstractAddBadgeStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/AbstractAddBadgeStep.java
@@ -23,30 +23,27 @@
  */
 package com.jenkinsci.plugins.badge.dsl;
 
-import java.io.Serializable;
-
 import com.jenkinsci.plugins.badge.action.BadgeAction;
-import com.jenkinsci.plugins.badge.annotations.OptionalParam;
-import com.jenkinsci.plugins.badge.annotations.Param;
-import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-import hudson.Extension;
 import hudson.model.Run;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
-import org.jenkinsci.plugins.workflow.steps.StepExecution;
 import org.jenkinsci.plugins.workflow.steps.SynchronousStepExecution;
-import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
 
+import java.io.Serializable;
+
 /**
  * Abstract class to add badges.
  */
 public abstract class AbstractAddBadgeStep extends AbstractStep {
 
   private final Badge badge;
 
-  public AbstractAddBadgeStep(@Param(name = "icon", description = "The icon for this badge") String icon,
-                              @Param(name = "text", description = "The text for this badge") String text) {
+  /**
+   * @param icon The icon for this badge
+   * @param text The text for this badge
+   */
+  public AbstractAddBadgeStep(String icon, String text) {
     this.badge = new Badge(icon, text);
   }
 
@@ -62,8 +59,10 @@ public String getLink() {
     return badge.getLink();
   }
 
+  /**
+   * @param link The link to be added to this badge
+   */
   @DataBoundSetter
-  @OptionalParam(description = "The link to be added to this badge")
   public void setLink(String link) {
     badge.setLink(link);
   }

diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/AbstractStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/AbstractStep.java
@@ -23,7 +23,6 @@
  */
 package com.jenkinsci.plugins.badge.dsl;
 
-import com.jenkinsci.plugins.badge.annotations.OptionalParam;
 import org.jenkinsci.plugins.workflow.steps.Step;
 import org.kohsuke.stapler.DataBoundSetter;
 
@@ -33,8 +32,10 @@
 abstract class AbstractStep extends Step {
   private String id;
 
+  /**
+   * @param id Badge identifier. Selectively delete badges by id.
+   */
   @DataBoundSetter
-  @OptionalParam(description = "Badge identifier. Selectively delete badges by id.")
   public void setId(String id) {
     this.id = id;
   }

diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStep.java
@@ -24,14 +24,10 @@
 package com.jenkinsci.plugins.badge.dsl;
 
 import com.jenkinsci.plugins.badge.action.BadgeAction;
-import com.jenkinsci.plugins.badge.annotations.OptionalParam;
-import com.jenkinsci.plugins.badge.annotations.Param;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Extension;
-import hudson.model.Run;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
 import org.jenkinsci.plugins.workflow.steps.StepExecution;
-import org.jenkinsci.plugins.workflow.steps.SynchronousStepExecution;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
 
@@ -40,18 +36,23 @@
  */
 public class AddBadgeStep extends AbstractAddBadgeStep {
 
+  /**
+   * @param icon The icon for this badge
+   * @param text The text for this badge
+   */
   @DataBoundConstructor
-  public AddBadgeStep(@Param(name = "icon", description = "The icon for this badge") String icon,
-                      @Param(name = "text", description = "The text for this badge") String text) {
+  public AddBadgeStep(String icon, String text) {
     super(icon, text);
   }
 
   public String getColor() {
     return getBadge().getColor();
   }
 
+  /**
+   * @param color The Jenkins palette/semantic color name of the badge icon symbol
+   */
   @DataBoundSetter
-  @OptionalParam(description = "The Jenkins palette/semantic color name of the badge icon symbol")
   public void setColor(String color) {
     getBadge().setColor(color);
   }

diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddErrorBadgeStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddErrorBadgeStep.java
@@ -24,7 +24,6 @@
 package com.jenkinsci.plugins.badge.dsl;
 
 import com.jenkinsci.plugins.badge.action.BadgeAction;
-import com.jenkinsci.plugins.badge.annotations.Param;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Extension;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
@@ -36,8 +35,11 @@
  */
 public class AddErrorBadgeStep extends AbstractAddBadgeStep {
 
+  /**
+   * @param text The text for this error badge
+   */
   @DataBoundConstructor
-  public AddErrorBadgeStep(@Param(name = "text", description = "The text for this error badge") String text) {
+  public AddErrorBadgeStep(String text) {
     super(null, text);
   }
 

diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStep.java
@@ -24,7 +24,6 @@
 package com.jenkinsci.plugins.badge.dsl;
 
 import com.jenkinsci.plugins.badge.action.HtmlBadgeAction;
-import com.jenkinsci.plugins.badge.annotations.Param;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.Extension;
@@ -41,8 +40,12 @@ public class AddHtmlBadgeStep extends AbstractStep {
 
   private final String html;
 
+  /**
+   *
+   * @param html The html content to be used for this badge
+   */
   @DataBoundConstructor
-  public AddHtmlBadgeStep(@Param(name = "html", description = "The html content to be used for this badge") String html) {
+  public AddHtmlBadgeStep(String html) {
     this.html = html;
   }
 

diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddInfoBadgeStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddInfoBadgeStep.java
@@ -24,7 +24,6 @@
 package com.jenkinsci.plugins.badge.dsl;
 
 import com.jenkinsci.plugins.badge.action.BadgeAction;
-import com.jenkinsci.plugins.badge.annotations.Param;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Extension;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
@@ -36,8 +35,11 @@
  */
 public class AddInfoBadgeStep extends AbstractAddBadgeStep {
 
+  /**
+   * @param text The info text for this badge
+   */
   @DataBoundConstructor
-  public AddInfoBadgeStep(@Param(name = "text", description = "The info text for this badge") String text) {
+  public AddInfoBadgeStep(String text) {
     super(null, text);
   }