You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2022/04/27 13:28:52 UTC

[uima-build-jenkins-shared-library] branch feature/UIMA-6437-Allow-publishing-HTML-documentation-from-Jenkinsfile updated: [UIMA-6437] Allow publishing HTML documentation from Jenkinsfile

This is an automated email from the ASF dual-hosted git repository.

rec pushed a commit to branch feature/UIMA-6437-Allow-publishing-HTML-documentation-from-Jenkinsfile
in repository https://gitbox.apache.org/repos/asf/uima-build-jenkins-shared-library.git


The following commit(s) were added to refs/heads/feature/UIMA-6437-Allow-publishing-HTML-documentation-from-Jenkinsfile by this push:
     new 708d84d  [UIMA-6437] Allow publishing HTML documentation from Jenkinsfile
708d84d is described below

commit 708d84d2590716f0efaae6e424abc89724f3e6e6
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Wed Apr 27 15:28:47 2022 +0200

    [UIMA-6437] Allow publishing HTML documentation from Jenkinsfile
    
    - Changed so that multiple documentation configs can be specified and that documentation builds can be done on PR builds and SNAPSHOT builds
---
 vars/createConfiguration.groovy |  2 +-
 vars/defaultPipeline.groovy     | 23 +++++++++--------------
 2 files changed, 10 insertions(+), 15 deletions(-)

diff --git a/vars/createConfiguration.groovy b/vars/createConfiguration.groovy
index 7c316a6..d532f9e 100644
--- a/vars/createConfiguration.groovy
+++ b/vars/createConfiguration.groovy
@@ -23,7 +23,7 @@ def call(body) {
     maven: 'maven_latest',
     jdk: 'jdk_1.8_latest',
     extraMavenArguments: '',
-    docPath: null
+    documentation: []
   ]
   
   body.resolveStrategy = Closure.DELEGATE_FIRST
diff --git a/vars/defaultPipeline.groovy b/vars/defaultPipeline.groovy
index b3e150e..d7705e6 100644
--- a/vars/defaultPipeline.groovy
+++ b/vars/defaultPipeline.groovy
@@ -133,20 +133,15 @@ def call(body) {
             def javaDocIssues = scanForIssues tool: javaDoc()
             publishIssues issues: [mavenConsoleIssues, javaIssues, javaDocIssues]
           }
-          
-          script {
-            if (config.docPath != null) {
-              publishHTML([
-                allowMissing: false, 
-                alwaysLinkToLastBuild: true, 
-                keepAll: false, 
-                reportDir: config.docPath, 
-                includes: '**/*',
-                reportFiles: 'index.html', 
-                reportName: 'Documentation', 
-                reportTitles: 'Documentation'
-              ])
-            }
+        }
+      }
+      
+      stage("Documentation build") {
+        when { config.documentation.size() > 0 }
+        
+        script {
+          for (doc in config.documentation) {
+            publishHTML(doc)
           }
         }
       }