From 3b18c3f1fd3726dfebff43f47b14e8bba3476632 Mon Sep 17 00:00:00 2001
From: Gerald Combs <gerald@wireshark.org>
Date: Tue, 4 May 2021 11:47:33 -0700
Subject: [PATCH] GitLab CI: Distribute our documentation.

Rename the "docbook" job to "documentation". Make sure we can do syntax
highlighting and produce PDFs. Distribute the docs that we build. Allow
the job to be manually run if we don't update any documentation sources.
---
 .gitlab-ci.yml | 29 +++++++++++++++++------------
 1 file changed, 17 insertions(+), 12 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 63ae792db0..c0ee5e66a4 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -276,9 +276,8 @@ test:debian-stable:
   needs:
     - build:debian-stable
 
-# Build Wireshark manuals
-# Note: Need ubuntu:focal with `ruby-coderay` and `ruby-asciidoctor-pdf` packages to build PDF docs
-docbook:
+# Build the User's Guide and Developer's Guide
+documentation:
   stage: build
   image: wireshark/wireshark-ubuntu-dev
   rules:
@@ -287,24 +286,30 @@ docbook:
         - "docbook/**"
         - "epan/wslua/**"
       when: always
-    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_PROJECT_URL !~ /.*gitlab.com\/wireshark\/wireshark/'
+    - if: '$CI_PIPELINE_SOURCE == "push"'
       when: manual
   script:
+    # XXX We might want to move this to wireshark-ubuntu-dev or debian-setup.sh.
+    - DEBIAN_FRONTEND=noninteractive apt-get update
+    - DEBIAN_FRONTEND=noninteractive apt-get --yes install ruby-coderay ruby-asciidoctor-pdf
     - mkdir build
     - cd build
     - cmake -GNinja ..
     - ninja all_guides
+    - cd docbook
+    - for HTML_DIR in wsug_html wsug_html_chunked wsdg_html wsdg_html_chunked ; do zip -9 -r "$HTML_DIR.zip" "$HTML_DIR" ; done
   after_script:
-    - mv build/docbook/wsug_html/ .
-    - mv build/docbook/wsug_html_chunked/ .
-    - mv build/docbook/wsdg_html/ .
-    - mv build/docbook/wsdg_html_chunked/ .
+    - mv -v build/docbook/ws[ud]g_html{,_chunked}.zip .
+    - mv -v build/docbook/{user,developer}-guide.pdf .
+    - if [ -n "$AWS_ACCESS_KEY_ID" ] && [ -n "$AWS_SECRET_ACCESS_KEY" ] && [ -n "$S3_DESTINATION_DOCS" ] ; then aws s3 cp ws[ud]g_html{,_chunked} {user,developer}-guide.pdf "$S3_DESTINATION_DOCS/" ; fi
   artifacts:
     paths:
-      - wsug_html/
-      - wsug_html_chunked/
-      - wsdg_html/
-      - wsdg_html_chunked/
+      - wsug_html.zip
+      - wsug_html_chunked.zip
+      - wsdg_html.zip
+      - wsdg_html_chunked.zip
+      - user-guide.pdf
+      - developer-guide.pdf
   needs: []