Skip to content

Commit

Permalink
Build a dummy(empty) javadoc of finagle and jdk-http plugins (#499)
Browse files Browse the repository at this point in the history
* Build a dummy(empty) javadoc of finagle and jdk-http plugins

* Add javadoc check for the CI.
  • Loading branch information
wu-sheng committed Apr 3, 2023
1 parent 81afedd commit f179b65
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
34 changes: 34 additions & 0 deletions apm-sniffer/apm-sdk-plugin/finagle-6.25.x-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
34 changes: 34 additions & 0 deletions apm-sniffer/bootstrap-plugins/jdk-http-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>

0 comments on commit f179b65

Please sign in to comment.