Add workaround for javadoc verify jobs

Nexus unpack plugin throws a "504 gateway timeout" for jobs archiving
large number of small files. Remove the workaround only we move away
from using Nexus as the log server.

Tested the workaround with javadoc-verify job.
https://logs.opendaylight.org/releng/vex-yul-odl-jenkins-1/bgpcep-maven-javadoc-verify-sodium-openjdk8/189

Issue: IT-16635
Change-Id: Ic7b0e3a56800312e3bcb888b4d35f9ccfd2d5018
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>

diff --git a/releasenotes/notes/add-workaround-javadocs-verify-jobs-2e482db630a6050d.yaml b/releasenotes/notes/add-workaround-javadocs-verify-jobs-2e482db630a6050d.yaml
new file mode 100644 (file)
index 0000000..e7abaa2
--- /dev/null
+++ b/releasenotes/notes/add-workaround-javadocs-verify-jobs-2e482db630a6050d.yaml
@@ -0,0 +1,7 @@
+---
+fixes:
+  - |
+    Tarball the $JAVADOC_DIR as a workaround for javadoc verfiy jobs
+    to avoid uploading a large number of small files. Uploading a large number
+    of small files does not work well with Nexus unpack plugin which
+    fails on 504 gateway timeout.

diff --git a/shell/maven-javadoc-generate.sh b/shell/maven-javadoc-generate.sh
index 99590d6..ec4743a 100644 (file)
--- a/shell/maven-javadoc-generate.sh
+++ b/shell/maven-javadoc-generate.sh
@@ -33,3 +33,14 @@ $MVN clean install javadoc:aggregate \
     $MAVEN_OPTIONS $MAVEN_PARAMS
 
 mv "$WORKSPACE/target/site/apidocs" "$JAVADOC_DIR"
+
+# TODO: Nexus unpack plugin throws a "504 gateway timeout" for jobs archiving
+# large number of small files. Remove the workaround only we move away from
+# using Nexus as the log server.
+if [[ "$JOB_NAME" =~ "javadoc-verify" ]]; then
+    # Tarball the javadoc dir and rm the directory to avoid re-upload into logs
+    pushd "$JAVADOC_DIR"
+    tar cvJf "$WORKSPACE/archives/javadoc.tar.xz" .
+    rm -rf "$JAVADOC_DIR"
+    popd
+fi