BFD-3149: Add apidocgen property to control api doc generation (#2124)

CMSgov · Jan 3, 2024 · a7af1eb · a7af1eb
1 parent c20393f
commit a7af1eb
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/ci-java.yml b/.github/workflows/ci-java.yml
@@ -101,7 +101,7 @@ jobs:
           EOF
 
       - name: 'Run Maven Build'
-        run: mvn --threads 1C --quiet --batch-mode -Dmaven.build.cache.enabled=false verify
+        run: mvn --threads 1C --quiet --batch-mode -Dmaven.build.cache.enabled=false -Dapidocgen.skip=false verify
         working-directory: ./apps
 
       - name: 'Install yq'

diff --git a/apps/bfd-server/bfd-server-war/pom.xml b/apps/bfd-server/bfd-server-war/pom.xml
@@ -430,6 +430,7 @@
                                 <argument>${project.basedir}</argument>
                                 <argument>${project.basedir}/../../../dist</argument>
                             </arguments>
+                            <skip>${apidocgen.skip}</skip>
                         </configuration>
                         <id>create-openapi-artifacts</id>
                         <phase>verify</phase>
@@ -488,6 +489,7 @@
                                     <classifier>data-dictionary</classifier>
                                 </artifact>
                             </artifacts>
+                            <skipAttach>${apidocgen.skip}</skipAttach>
                         </configuration>
                     </execution>
                 </executions>

diff --git a/apps/pom.xml b/apps/pom.xml
@@ -216,6 +216,9 @@
         <!-- Skip by default.  Override to allow images to be built. -->
         <jib.skip>true</jib.skip>
 
+        <!-- Skip by default.  Override to let open api documents be generated. -->
+        <apidocgen.skip>true</apidocgen.skip>
+
         <!-- maven plugin versions -->
         <maven.assembly.plugin.version>3.6.0</maven.assembly.plugin.version>
         <maven.antrun.plugin.version>3.1.0</maven.antrun.plugin.version>
@@ -1275,6 +1278,7 @@
                 <maven.source.skip>true</maven.source.skip>
                 <maven.javadoc.skip>true</maven.javadoc.skip>
                 <checkstyle.skip>true</checkstyle.skip>
+                <apidocgen.skip>false</apidocgen.skip>
             </properties>
             <distributionManagement>
                 <repository>