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.
This commit is contained in:
吴晟 Wu Sheng 2023-04-03 15:24:31 +08:00 committed by GitHub
parent 81afeddd08
commit f179b65994
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 70 additions and 1 deletions

View File

@ -66,7 +66,7 @@ jobs:
- name: Check Javaagent Plugin List
run: tools/plugin/check-javaagent-plugin-list.sh
- name: Install and Test
run: ./mvnw -q --batch-mode clean verify install
run: ./mvnw -q --batch-mode clean verify install javadoc:javadoc
ci:
name: CI

View File

@ -25,6 +25,7 @@ Release Notes.
* Fix a thread leak in `SamplingService` when updated sampling policy in the runtime.
* Support MySQL plugin tracing SQL parameters when useServerPrepStmts
* Update the endpoint name of `Undertow` plugin to `Method:Path`.
* Build a dummy(empty) javadoc of finagle and jdk-http plugins due to incompatibility.
#### Documentation
* Update docs of Tracing APIs, reorganize the API docs into six parts.

View File

@ -54,6 +54,40 @@
<build>
<plugins>
<!-- Build a dummy(empty) javadoc to satisfy maven central requirements -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
<configuration>
<failOnError>false</failOnError>
</configuration>
</plugin>
<!-- Ignore the error of javadoc build -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<executions>
<execution>
<id>empty-javadoc-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<classifier>javadoc</classifier>
<classesDirectory>${basedir}/javadoc</classesDirectory>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>net.alchim31.maven</groupId>
<artifactId>scala-maven-plugin</artifactId>

View File

@ -40,6 +40,40 @@
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
</plugin>
<!-- Ignore the error of javadoc build -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
<configuration>
<failOnError>false</failOnError>
</configuration>
</plugin>
<!-- Build a dummy(empty) javadoc to satisfy maven central requirements -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<executions>
<execution>
<id>empty-javadoc-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<classifier>javadoc</classifier>
<classesDirectory>${basedir}/javadoc</classesDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>