keep the options at one place

awslabs · Sep 9, 2024 · 5854997 · 5854997
1 parent 79ac10e
commit 5854997
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 14 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -274,7 +274,7 @@ jobs:
 
   # check that docs can still build
   check-docs:
-    runs-on: ubuntu-22.04 # latest
+    runs-on: ubuntu-22.04 # use same version as docs.yml
     steps:
       - uses: actions/checkout@v3
         with:

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -9,7 +9,7 @@ on:
 
 jobs:
   update-docs-branch:
-    runs-on: ubuntu-20.04 # latest
+    runs-on: ubuntu-22.04 # use same version as ci.yml's check-docs
     permissions:
       contents: write # allow push
     steps:

diff --git a/javadoc.options b/javadoc.options
diff --git a/make-docs.sh b/make-docs.sh
@@ -9,5 +9,7 @@ rm -rf docs/
 
 # build
 mvn clean javadoc:javadoc -Prelease
+# mvn generates the doc in apidocs/ subfolder, move it out
+mv docs/apidocs/* docs/
 
 popd >/dev/null
diff --git a/pom.xml b/pom.xml
@@ -294,16 +294,18 @@
                         <artifactId>maven-javadoc-plugin</artifactId>
                         <version>3.4.0</version>
                         <configuration>
-                            <!-- <subpackages>software.amazon.awssdk.crt</subpackages> -->
+                            <reportOutputDirectory>${project.basedir}/docs</reportOutputDirectory>
                             <windowtitle>AWS Common Runtime for Java/JVM</windowtitle>
                             <doctitle>AWS Common Runtime for Java/JVM</doctitle>
                             <header>AWS Common Runtime for Java/JVM</header>
                             <bottom>Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.</bottom>
-                            <reportOutputDirectory>${project.basedir}/docs</reportOutputDirectory>
+                            <show>public</show>
+                            <sourcepath>src/main/java</sourcepath>
+                            <notimestamp>true</notimestamp>
+                            <quiet>true</quiet>
+                            <doclint>all,-missing</doclint>
+                            <failOnWarnings>true</failOnWarnings>
                             <excludePackageNames>software.amazon.awssdk.crt.internal</excludePackageNames>
-                            <additionalJOptions>
-                                @${project.basedir}/javadoc.options
-                            </additionalJOptions>
                         </configuration>
                         <executions>
                             <execution>