From 8680e26a3c28513f6ee6699646294aecd78bf061 Mon Sep 17 00:00:00 2001 From: Glenn Oppegard Date: Tue, 27 Jun 2023 12:55:01 -0600 Subject: [PATCH 1/3] Check that Javadocs build in CI --- .github/workflows/maven.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index cf136ee5..38815042 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -24,4 +24,6 @@ jobs: distribution: 'temurin' cache: maven - name: Build with Maven - run: mvn -B package --file pom.xml + run: mvn --batch-mode --file pom.xml package + - name: Check Javadocs + run: mvn --batch-mode --file pom.xml --activate-profiles release org.apache.maven.plugins:maven-javadoc-plugin:jar From 109283745f2e772d6324a893d84c7162cb8adfda Mon Sep 17 00:00:00 2001 From: Glenn Oppegard Date: Tue, 27 Jun 2023 12:58:43 -0600 Subject: [PATCH 2/3] Fix Javadoc HTML errors --- .../java/com/wavefront/sdk/common/Utils.java | 4 +- .../clients/WavefrontClientFactory.java | 40 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/src/main/java/com/wavefront/sdk/common/Utils.java b/src/main/java/com/wavefront/sdk/common/Utils.java index 0d47ca10..ec2263c1 100644 --- a/src/main/java/com/wavefront/sdk/common/Utils.java +++ b/src/main/java/com/wavefront/sdk/common/Utils.java @@ -653,9 +653,9 @@ public static Optional getVersion(String artifactId) { * {@code META-INF/}. The file should contain a line that specifies the project version as * "project.version". * Format of semantic version gauge value reported to Wavefront = - * .<2-digit-minorVersion><2-digit-patchVersion> + * <majorVersion>.<2-digit-minorVersion><2-digit-patchVersion> * - * Ex: v2.6.1 => 2.0601 + * Ex: v2.6.1 => 2.0601 * * @param artifactId * @return the version Gauge value for the given artifactId diff --git a/src/main/java/com/wavefront/sdk/common/clients/WavefrontClientFactory.java b/src/main/java/com/wavefront/sdk/common/clients/WavefrontClientFactory.java index 2e4ce917..302db6f6 100644 --- a/src/main/java/com/wavefront/sdk/common/clients/WavefrontClientFactory.java +++ b/src/main/java/com/wavefront/sdk/common/clients/WavefrontClientFactory.java @@ -42,10 +42,10 @@ public WavefrontClientFactory addClient(WavefrontSender sender) { /** * Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service. - *
- * proxy ingestion: proxy://your.proxy.com:port
- * direct ingestion: https://token@yourCluster.wavefront.com
- *
+ *
+ * proxy ingestion: proxy://your.proxy.com:port
+ * direct ingestion: https://token@yourCluster.wavefront.com
+ *
* * @param url The URL of either yourCluster or your.proxy.com * @@ -58,10 +58,10 @@ public WavefrontClientFactory addClient(String url) { /** * Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service. - *
- * proxy ingestion: proxy://your.proxy.com:port
- * direct ingestion: https://token@yourCluster.wavefront.com
- *
+ *
+ * proxy ingestion: proxy://your.proxy.com:port
+ * direct ingestion: https://token@yourCluster.wavefront.com
+ *
* * @param url The URL of either yourCluster or your.proxy.com * @param batchSize The total metrics, histograms, spans, or span logs to send in a single flush @@ -77,10 +77,10 @@ public WavefrontClientFactory addClient(String url, @Nullable Integer batchSize, /** * Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service. - *
- * proxy ingestion: proxy://your.proxy.com:port
- * direct ingestion: https://token@yourCluster.wavefront.com
- *
+ *
+ * proxy ingestion: proxy://your.proxy.com:port
+ * direct ingestion: https://token@yourCluster.wavefront.com
+ *
* * @param url The URL of either yourCluster or your.proxy.com * @param batchSize The total metrics, histograms, spans, or span logs to send in a single flush @@ -98,10 +98,10 @@ public WavefrontClientFactory addClient(String url, @Nullable Integer batchSize, /** * Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service. - *
- * proxy ingestion: proxy://your.proxy.com:port
- * direct ingestion: https://token@yourCluster.wavefront.com
- *
+ *
+ * proxy ingestion: proxy://your.proxy.com:port
+ * direct ingestion: https://token@yourCluster.wavefront.com
+ *
* * @param url The URL of either yourCluster or your.proxy.com * @param batchSize The total metrics, histograms, spans, or span logs to send in a single flush @@ -124,10 +124,10 @@ public WavefrontClientFactory addClient(String url, @Nullable Integer batchSize, /** * Adds a new WavefrontSender that will either forward points to a proxy or directly to a Wavefront service. - *
- * proxy ingestion: proxy://your.proxy.com:port
- * direct ingestion: https://token@yourCluster.wavefront.com
- *
+ *
+ * proxy ingestion: proxy://your.proxy.com:port
+ * direct ingestion: https://token@yourCluster.wavefront.com
+ *
* * @param url The URL of either yourCluster or your.proxy.com * @param batchSize The total metrics, histograms, spans, or span logs to send in a single flush From 1e87661e27783ebf27432fca5924291e1d20f514 Mon Sep 17 00:00:00 2001 From: Glenn Oppegard Date: Tue, 27 Jun 2023 13:01:14 -0600 Subject: [PATCH 3/3] Bump maven-javadoc-plugin to 3.5.0 --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 85a70232..bf9da1b8 100644 --- a/pom.xml +++ b/pom.xml @@ -149,7 +149,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.4.1 + 3.5.0 attach-javadocs