Cleanup docs and build

Author: strangelookingnerd

.github/workflows/release-drafter.yml

@@ -5,7 +5,7 @@ name: Release Drafter
 on:
   push:
     branches:
-      - main
+      - "main"
     tags:
       - '*'
 

Jenkinsfile

@@ -1,8 +1,7 @@
 // Builds the plugin using https://github.com/jenkins-infra/pipeline-library
 buildPlugin(useContainerAgent: true, configurations: [
   // Test the minimum required Jenkins Version.
-  [ platform: 'linux', jdk: '11', jenkins: null ],
-  [ platform: 'windows', jdk: '11', jenkins: null ],
-  [ platform: 'linux', jdk: '17', jenkins: null ],
-  [ platform: 'windows', jdk: '17', jenkins: null ]
+  [ platform: 'linux', jdk: '11'],
+  [ platform: 'windows', jdk: '11'],
+  [ platform: 'linux', jdk: '17']
 ])

README.adoc

@@ -1,6 +1,18 @@
+[[apache-httpcomponents-client-5-api-plugin]]
 = Apache HttpComponents Client 5.x API Plugin for Jenkins
+:toc: macro
+:toclevels: 3
+:toc-title:
+
+image:https://ci.jenkins.io/job/Plugins/job/apache-httpcomponents-client-5-api-plugin/job/main/badge/icon[link="https://ci.jenkins.io/job/Plugins/job/apache-httpcomponents-client-5-api-plugin/job/main/"]
+image:https://github.com/jenkinsci/apache-httpcomponents-client-5-api-plugin/actions/workflows/jenkins-security-scan.yml/badge.svg[link="https://github.com/jenkinsci/apache-httpcomponents-client-5-api-plugin/actions/workflows/jenkins-security-scan.yml"]
+
+image:https://img.shields.io/jenkins/plugin/i/apache-httpcomponents-client-5-api.svg?color=blue&label=installations[link="https://stats.jenkins.io/pluginversions/apache-httpcomponents-client-5-api.html"]
+image:https://img.shields.io/github/contributors/jenkinsci/apache-httpcomponents-client-5-api-plugin.svg?color=blue[link="https://github.com/jenkinsci/apache-httpcomponents-client-5-api-plugin/graphs/contributors"]
+image:https://img.shields.io/github/release/jenkinsci/apache-httpcomponents-client-5-api-plugin.svg?label=changelog[link="https://github.com/jenkinsci/apache-httpcomponents-client-5-api-plugin/releases/latest"]
+
+This plugin bundles all the components of https://hc.apache.org/httpcomponents-client-5.2.x/index.html[Apache HttpComponents Client 5.x] except `httpclient5-win` because of the dependency on jna.
 
-This plugin bundles all the components of https://hc.apache.org/httpcomponents-client-5.2.x/index.html[Apache HttpComponents Client 5.2.x] except `httpclient5-win` because of the dependency on jna.
 These components can be used by other plugins as a dependency.
 It allows managing library updates independently of plugins.
 
@@ -10,7 +22,7 @@ It allows managing library updates independently of plugins.
 
 Replace the dependency to `org.apache.httpcomponents.client5:httpclient5` with the dependency to `apache-httpcomponents-client-5-api`.
 
-* Before:
+*Before:*
 
 ----
 <dependencies>
@@ -24,7 +36,7 @@ Replace the dependency to `org.apache.httpcomponents.client5:httpclient5` with t
 </dependencies>
 ----
 
-* After:
+*After:*
 
 ----
 <dependencies>
@@ -40,9 +52,9 @@ Replace the dependency to `org.apache.httpcomponents.client5:httpclient5` with t
 
 === Plugins using libraries depending on httpclient5
 
-Add the dependency to `apache-httpcomponents-client-5-api` BEFORE any of dependencies to those libraries to force maven to use `httpclient5` declared by `apache-httpcomponents-client-5-api`.
+Add the dependency to `apache-httpcomponents-client-5-api` *before* any of dependencies to those libraries to force maven to use `httpclient5` declared by `apache-httpcomponents-client-5-api`.
 
-* Before:
+*Before:*
 
 ----
 <dependencies>
@@ -59,7 +71,7 @@ Add the dependency to `apache-httpcomponents-client-5-api` BEFORE any of depende
 </dependencies>
 ----
 
-* After:
+*After:*
 
 ----
 <dependencies>
@@ -81,6 +93,12 @@ Add the dependency to `apache-httpcomponents-client-5-api` BEFORE any of depende
 </dependencies>
 ----
 
+== Versioning
+
+Version follows the pattern of `<org.apache.httpcomponents version>-<plugin version>`.
+
+This way it is clear what upstream dependency is offered and allows patch releases for the plugin itself if required.
+
 == Release Notes
 
 Release notes are recorded in https://github.com/jenkinsci/apache-httpcomponents-client-5-api-plugin/releases[GitHub Releases].

pom.xml

@@ -25,7 +25,8 @@
     </properties>
 
     <name>Apache HttpComponents Client 5.x API Plugin</name>
-    <description>Bundles Apache HttpComponents Client 5.x and allows it to be used by Jenkins plugins</description>
+    <description>Bundles Apache HttpComponents Client ${revision} and allows it to be used by Jenkins plugins
+    </description>
     <url>https://github.com/${gitHubRepo}</url>
 
     <licenses>
@@ -71,16 +72,34 @@
             <groupId>org.apache.httpcomponents.client5</groupId>
             <artifactId>httpclient5</artifactId>
             <version>${httpclient.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.slf4j</groupId>
+                    <artifactId>slf4j-api</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents.client5</groupId>
             <artifactId>httpclient5-cache</artifactId>
             <version>${httpclient.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.slf4j</groupId>
+                    <artifactId>slf4j-api</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents.client5</groupId>
             <artifactId>httpclient5-fluent</artifactId>
             <version>${httpclient.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.slf4j</groupId>
+                    <artifactId>slf4j-api</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
     </dependencies>