Skip to content

Commit f179b65

Browse files
authored
Build a dummy(empty) javadoc of finagle and jdk-http plugins (#499)
* Build a dummy(empty) javadoc of finagle and jdk-http plugins * Add javadoc check for the CI.
1 parent 81afedd commit f179b65

File tree

4 files changed

+70
-1
lines changed

4 files changed

+70
-1
lines changed

.github/workflows/ci.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ jobs:
6666
- name: Check Javaagent Plugin List
6767
run: tools/plugin/check-javaagent-plugin-list.sh
6868
- name: Install and Test
69-
run: ./mvnw -q --batch-mode clean verify install
69+
run: ./mvnw -q --batch-mode clean verify install javadoc:javadoc
7070

7171
ci:
7272
name: CI

CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Release Notes.
2525
* Fix a thread leak in `SamplingService` when updated sampling policy in the runtime.
2626
* Support MySQL plugin tracing SQL parameters when useServerPrepStmts
2727
* Update the endpoint name of `Undertow` plugin to `Method:Path`.
28+
* Build a dummy(empty) javadoc of finagle and jdk-http plugins due to incompatibility.
2829

2930
#### Documentation
3031
* Update docs of Tracing APIs, reorganize the API docs into six parts.

apm-sniffer/apm-sdk-plugin/finagle-6.25.x-plugin/pom.xml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,40 @@
5454

5555
<build>
5656
<plugins>
57+
<!-- Build a dummy(empty) javadoc to satisfy maven central requirements -->
58+
<plugin>
59+
<groupId>org.apache.maven.plugins</groupId>
60+
<artifactId>maven-javadoc-plugin</artifactId>
61+
<executions>
62+
<execution>
63+
<id>attach-javadocs</id>
64+
<goals>
65+
<goal>jar</goal>
66+
</goals>
67+
</execution>
68+
</executions>
69+
<configuration>
70+
<failOnError>false</failOnError>
71+
</configuration>
72+
</plugin>
73+
<!-- Ignore the error of javadoc build -->
74+
<plugin>
75+
<groupId>org.apache.maven.plugins</groupId>
76+
<artifactId>maven-jar-plugin</artifactId>
77+
<executions>
78+
<execution>
79+
<id>empty-javadoc-jar</id>
80+
<phase>package</phase>
81+
<goals>
82+
<goal>jar</goal>
83+
</goals>
84+
<configuration>
85+
<classifier>javadoc</classifier>
86+
<classesDirectory>${basedir}/javadoc</classesDirectory>
87+
</configuration>
88+
</execution>
89+
</executions>
90+
</plugin>
5791
<plugin>
5892
<groupId>net.alchim31.maven</groupId>
5993
<artifactId>scala-maven-plugin</artifactId>

apm-sniffer/bootstrap-plugins/jdk-http-plugin/pom.xml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,40 @@
4040
<plugin>
4141
<artifactId>maven-deploy-plugin</artifactId>
4242
</plugin>
43+
<!-- Ignore the error of javadoc build -->
44+
<plugin>
45+
<groupId>org.apache.maven.plugins</groupId>
46+
<artifactId>maven-javadoc-plugin</artifactId>
47+
<executions>
48+
<execution>
49+
<id>attach-javadocs</id>
50+
<goals>
51+
<goal>jar</goal>
52+
</goals>
53+
</execution>
54+
</executions>
55+
<configuration>
56+
<failOnError>false</failOnError>
57+
</configuration>
58+
</plugin>
59+
<!-- Build a dummy(empty) javadoc to satisfy maven central requirements -->
60+
<plugin>
61+
<groupId>org.apache.maven.plugins</groupId>
62+
<artifactId>maven-jar-plugin</artifactId>
63+
<executions>
64+
<execution>
65+
<id>empty-javadoc-jar</id>
66+
<phase>package</phase>
67+
<goals>
68+
<goal>jar</goal>
69+
</goals>
70+
<configuration>
71+
<classifier>javadoc</classifier>
72+
<classesDirectory>${basedir}/javadoc</classesDirectory>
73+
</configuration>
74+
</execution>
75+
</executions>
76+
</plugin>
4377
</plugins>
4478
</build>
4579
</project>

0 commit comments

Comments
 (0)