feat(ci): add javadoc staging stage

* Stage Javadoc snapshot versions through the Pipeline CI. The Javadoc staging stage is on the Daily CE Pipeline. It is triggered only daily, on SCM change. Related to CAM-13784, closes camunda#1560
www-jrtorres042-github-enterprise-org · Sep 16, 2021 · fd95efc · fd95efc
1 parent 69e8372
commit fd95efc
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 9 deletions.
diff --git a/.ci/daily/Jenkinsfile b/.ci/daily/Jenkinsfile
@@ -53,14 +53,39 @@ pipeline {
         ])
       }
     }
-    stage('check-sql-scripts') {
-      steps {
-        cambpmConditionalRetry([
-          agentLabel: 'centos-stable',
-          runSteps: {
-            sh '.ci/scripts/check-sql-scripts.sh'
+    stage('Misc') {
+      parallel {
+        stage('check-sql-scripts') {
+          steps {
+            cambpmConditionalRetry([
+              agentLabel: 'centos-stable',
+              runSteps: {
+                sh '.ci/scripts/check-sql-scripts.sh'
+              }
+            ])
           }
-        ])
+        }
+        stage('stage-javadocs') {
+          when {
+            branch cambpmDefaultBranch();
+          }
+          steps {
+            cambpmConditionalRetry([
+              agentLabel : 'centos-stable',
+              runSteps   : {
+                sh 'mkdir -p ./webapps/target/webapp'
+                cambpmRunMaven('.',
+                  'package javadoc:javadoc javadoc:aggregate -Pdistro,distro-wildfly,distro-webjar,javadocs -DskipTests=true -Dskip.frontend.build=true',
+                  withNpm: true,
+                  jdkVersion: 'jdk-11-latest')
+              },
+              postSuccess: {
+                def projectVersion = cambpmUtils.getMavenProjectVersion()
+                cambpmPublishJavadocs("\"target/site/apidocs/\"", projectVersion)
+              }
+            ])
+          }
+        }
       }
     }
     stage('Standalone QA tests') {

diff --git a/parent/pom.xml b/parent/pom.xml
@@ -255,8 +255,12 @@
           <artifactId>maven-javadoc-plugin</artifactId>
           <configuration>
             <failOnError>false</failOnError>
-            <doclint>none</doclint>
-            <quiet>true</quiet>
+            <additionalJOptions>
+              <additionalJOption>-Xdoclint:none</additionalJOption>
+              <additionalJOption>--ignore-source-errors</additionalJOption>
+            </additionalJOptions>
+            <doctitle>Camunda Platform Javadocs ${project.version}</doctitle>
+            <windowtitle>Camunda Platform Javadocs ${project.version}</windowtitle>
           </configuration>
         </plugin>
       </plugins>

diff --git a/pom.xml b/pom.xml
@@ -124,6 +124,27 @@
       </modules>
     </profile>
 
+    <profile>
+      <id>javadocs</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-javadoc-plugin</artifactId>
+            <configuration>
+              <failOnError>false</failOnError>
+              <additionalJOptions>
+                <additionalJOption>-Xdoclint:none</additionalJOption>
+                <additionalJOption>--ignore-source-errors</additionalJOption>
+              </additionalJOptions>
+              <doctitle>Camunda Platform Javadocs ${project.version}</doctitle>
+              <windowtitle>Camunda Platform Javadocs ${project.version}</windowtitle>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+
     <profile>
       <id>distro-serverless</id>
       <modules>