Skip to content

Commit b3da95a

Browse files
igorbernstein2igorbernstein2
authored
chore: fix javadoc site after repo split (#89)
* To ensure that the excludes are respected by both the aggregate site and the javadoc jars * move the javadoc config from reporting to build configs: this is necessary because the javadoc:jar is run as part of the build phase * move the javadoc config to the parent pom so that it can be used by both the aggregate site goal and the javadoc jars * Exclude the grpc & protobuf stubs from the aggregate site: they are not part of the public api in the java client * Remove unused external links * Stop generating unused site reports, we only use the javadocs
1 parent 83ac4c8 commit b3da95a

File tree

3 files changed

+80
-128
lines changed

3 files changed

+80
-128
lines changed

‎google-cloud-bigtable-bom/pom.xml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,16 @@
111111
<skip>true</skip>
112112
</configuration>
113113
</plugin>
114+
115+
<!-- Using maven site plugin only as a hook for javadoc:aggregate, don't need the reports -->
116+
<plugin>
117+
<groupId>org.apache.maven.plugins</groupId>
118+
<artifactId>maven-site-plugin</artifactId>
119+
120+
<configuration>
121+
<generateReports>false</generateReports>
122+
</configuration>
123+
</plugin>
114124
</plugins>
115125
</build>
116126
</project>

‎google-cloud-bigtable/pom.xml‎

Lines changed: 0 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -369,74 +369,4 @@
369369
</plugin>
370370
</plugins>
371371
</build>
372-
373-
<reporting>
374-
<plugins>
375-
<plugin>
376-
<groupId>org.apache.maven.plugins</groupId>
377-
<artifactId>maven-javadoc-plugin</artifactId>
378-
<version>3.1.1</version>
379-
<configuration>
380-
<show>protected</show>
381-
<nohelp>true</nohelp>
382-
<doclint>none</doclint>
383-
<splitindex>true</splitindex>
384-
385-
<sourceFileExcludes>
386-
<!-- TODO(igorbernstein): use a custom doclet to exclude @InternalApi classes from javadoc -->
387-
<!-- Hide @InternalApi classes -->
388-
<exclude>com/google/cloud/bigtable/gaxx/**</exclude>
389-
390-
<!-- Hide @InternalApi classes for InstanceAdmin -->
391-
<exclude>com/google/cloud/bigtable/admin/v2/internal/**</exclude>
392-
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminClient.java</exclude>
393-
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminSettings.java</exclude>
394-
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminCallableFactory.java</exclude>
395-
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminStub.java</exclude>
396-
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableInstanceAdminStub.java</exclude>
397-
398-
<!-- Hide @InternalApi classes for TableAdmin -->
399-
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminClient.java</exclude>
400-
<exclude>com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminSettings.java</exclude>
401-
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminCallableFactory.java</exclude>
402-
<exclude>com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminStub.java</exclude>
403-
<exclude>com/google/cloud/bigtable/admin/v2/stub/BigtableTableAdminStub.java</exclude>
404-
<exclude>com/google/cloud/bigtable/admin/v2/stub/EnhancedBigtableTableAdminStub.java</exclude>
405-
406-
<!-- Hide @InternalApi classes for Data -->
407-
<exclude>com/google/cloud/bigtable/data/v2/internal/**</exclude>
408-
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java</exclude>
409-
<exclude>com/google/cloud/bigtable/data/v2/BaseBigtableDataSettings.java</exclude>
410-
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStub.java</exclude>
411-
<exclude>com/google/cloud/bigtable/data/v2/stub/BigtableStubSettings.java</exclude>
412-
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableStub.java</exclude>
413-
<exclude>com/google/cloud/bigtable/data/v2/stub/GrpcBigtableCallableFactory.java</exclude>
414-
<exclude>com/google/cloud/bigtable/data/v2/stub/EnhancedBigtableStub.java</exclude>
415-
<exclude>com/google/cloud/bigtable/data/v2/stub/mutaterows/**</exclude>
416-
<exclude>com/google/cloud/bigtable/data/v2/stub/readrows/**</exclude>
417-
<exclude>com/google/cloud/bigtable/data/v2/stub/metrics/**</exclude>
418-
</sourceFileExcludes>
419-
420-
<offlineLinks>
421-
<offlineLink>
422-
<url>${project.javadoc.protobufBaseURL}</url>
423-
<location>../../../../../google-api-grpc/proto-google-cloud-bigtable-v2/target/site/apidocs/</location>
424-
</offlineLink>
425-
<offlineLink>
426-
<url>${project.javadoc.protobufBaseURL}</url>
427-
<location>../../../../../google-api-grpc/grpc-google-cloud-bigtable-v2/target/site/apidocs/</location>
428-
</offlineLink>
429-
<offlineLink>
430-
<url>${project.javadoc.protobufBaseURL}</url>
431-
<location>../../../../../google-api-grpc/proto-google-cloud-bigtable-admin-v2/target/site/apidocs/</location>
432-
</offlineLink>
433-
<offlineLink>
434-
<url>${project.javadoc.protobufBaseURL}</url>
435-
<location>../../../../../google-api-grpc/grpc-google-cloud-bigtable-admin-v2/target/site/apidocs/</location>
436-
</offlineLink>
437-
</offlineLinks>
438-
</configuration>
439-
</plugin>
440-
</plugins>
441-
</reporting>
442372
</project>

‎pom.xml‎

Lines changed: 70 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -370,85 +370,97 @@
370370

371371
</plugins>
372372
</pluginManagement>
373-
</build>
374-
375-
<modules>
376-
<module>proto-google-cloud-bigtable-v2</module>
377-
<module>grpc-google-cloud-bigtable-v2</module>
378-
<module>proto-google-cloud-bigtable-admin-v2</module>
379-
<module>grpc-google-cloud-bigtable-admin-v2</module>
380-
<module>google-cloud-bigtable</module>
381-
<module>google-cloud-bigtable-emulator</module>
382-
<module>google-cloud-bigtable-bom</module>
383-
</modules>
384373

385-
<reporting>
386374
<plugins>
375+
<!-- Using maven site plugin only as a hook for javadoc:aggregate, don't need the reports -->
387376
<plugin>
388377
<groupId>org.apache.maven.plugins</groupId>
389-
<artifactId>maven-project-info-reports-plugin</artifactId>
390-
<version>3.0.0</version>
391-
<reportSets>
392-
<reportSet>
393-
<reports>
394-
<report>index</report>
395-
<report>dependency-info</report>
396-
<report>team</report>
397-
<report>ci-management</report>
398-
<report>issue-management</report>
399-
<report>licenses</report>
400-
<report>scm</report>
401-
<report>dependency-management</report>
402-
<report>distribution-management</report>
403-
<report>summary</report>
404-
<report>modules</report>
405-
</reports>
406-
</reportSet>
407-
</reportSets>
378+
<artifactId>maven-site-plugin</artifactId>
379+
408380
<configuration>
409-
<dependencyDetailsEnabled>true</dependencyDetailsEnabled>
410-
<artifactId>${site.installationModule}</artifactId>
411-
<packaging>jar</packaging>
381+
<generateReports>false</generateReports>
412382
</configuration>
413383
</plugin>
414384
<plugin>
415385
<groupId>org.apache.maven.plugins</groupId>
416386
<artifactId>maven-javadoc-plugin</artifactId>
417387
<version>3.1.1</version>
418-
<reportSets>
419-
<reportSet>
420-
<id>html</id>
421-
<reports>
422-
<report>aggregate</report>
423-
<report>javadoc</report>
424-
</reports>
425-
</reportSet>
426-
</reportSets>
388+
<executions>
389+
<execution>
390+
<id>aggregate</id>
391+
<inherited>false</inherited>
392+
<phase>site</phase>
393+
<goals>
394+
<goal>aggregate</goal>
395+
</goals>
396+
<configuration>
397+
<sourceFileExcludes combine.children="append">
398+
<!-- Exclude protobuf & grpc stubs from the public javadocs site. -->
399+
<sourceFileExclude>**/com/google/bigtable/**</sourceFileExclude>
400+
</sourceFileExcludes>
401+
</configuration>
402+
</execution>
403+
</executions>
404+
427405
<configuration>
428406
<doclint>none</doclint>
429407
<show>protected</show>
430408
<nohelp>true</nohelp>
431409
<outputDirectory>${project.build.directory}/javadoc</outputDirectory>
432-
<groups>
433-
<group>
434-
<title>Test helpers packages</title>
435-
<packages>com.google.cloud.testing</packages>
436-
</group>
437-
<group>
438-
<title>SPI packages</title>
439-
<packages>com.google.cloud.spi*</packages>
440-
</group>
441-
</groups>
442410

411+
<sourceFileExcludes>
412+
<!-- Hide InternalApi & non public classes from javadocs site and the javadoc jars -->
413+
<!-- TODO(igorbernstein): use a custom doclet to exclude @InternalApi classes from javadoc -->
414+
<!-- Hide @InternalApi classes -->
415+
<sourceFileExclude>**/com/google/cloud/bigtable/gaxx/**</sourceFileExclude>
416+
417+
<!-- Hide @InternalApi classes for InstanceAdmin -->
418+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/internal/**</sourceFileExclude>
419+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminClient.java</sourceFileExclude>
420+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/BaseBigtableInstanceAdminSettings.java</sourceFileExclude>
421+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminCallableFactory.java</sourceFileExclude>
422+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableInstanceAdminStub.java</sourceFileExclude>
423+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/BigtableInstanceAdminStub.java</sourceFileExclude>
424+
425+
<!-- Hide**/ @InternalApi classes for TableAdmin -->
426+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminClient.java</sourceFileExclude>
427+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/BaseBigtableTableAdminSettings.java</sourceFileExclude>
428+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminCallableFactory.java</sourceFileExclude>
429+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/GrpcBigtableTableAdminStub.java</sourceFileExclude>
430+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/BigtableTableAdminStub.java</sourceFileExclude>
431+
<sourceFileExclude>**/com/google/cloud/bigtable/admin/v2/stub/EnhancedBigtableTableAdminStub.java</sourceFileExclude>
432+
433+
<!-- Hide**/ @InternalApi classes for Data -->
434+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/internal/**</sourceFileExclude>
435+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java</sourceFileExclude>
436+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/BaseBigtableDataSettings.java</sourceFileExclude>
437+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/stub/BigtableStub.java</sourceFileExclude>
438+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/stub/BigtableStubSettings.java</sourceFileExclude>
439+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/stub/GrpcBigtableStub.java</sourceFileExclude>
440+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/stub/GrpcBigtableCallableFactory.java</sourceFileExclude>
441+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/stub/EnhancedBigtableStub.java</sourceFileExclude>
442+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/stub/mutaterows/**</sourceFileExclude>
443+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/stub/readrows/**</sourceFileExclude>
444+
<sourceFileExclude>**/com/google/cloud/bigtable/data/v2/stub/metrics/**</sourceFileExclude>
445+
</sourceFileExcludes>
446+
447+
<!-- Enable external linking -->
443448
<links>
444-
<link>https://grpc.io/grpc-java/javadoc/</link>
445-
<link>https://developers.google.com/protocol-buffers/docs/reference/java/</link>
446-
<link>https://googleapis.dev/java/google-auth-library/latest/</link>
447-
<link>https://googleapis.dev/java/gax/latest/</link>
449+
<link>https://googleapis.dev/java/gax/${gax.version}/</link>
448450
<link>https://googleapis.github.io/api-common-java/${google.api-common.version}/apidocs/</link>
449451
</links>
450452
</configuration>
451453
</plugin>
452454
</plugins>
453-
</reporting>
455+
</build>
456+
457+
<modules>
458+
<module>proto-google-cloud-bigtable-v2</module>
459+
<module>grpc-google-cloud-bigtable-v2</module>
460+
<module>proto-google-cloud-bigtable-admin-v2</module>
461+
<module>grpc-google-cloud-bigtable-admin-v2</module>
462+
<module>google-cloud-bigtable</module>
463+
<module>google-cloud-bigtable-emulator</module>
464+
<module>google-cloud-bigtable-bom</module>
465+
</modules>
454466
</project>

0 commit comments

Comments
 (0)