[#59] Add documentation build gate

This change introduces a job to build airshipctl documentation and
publish a preview for each new PS.

Related #59

Change-Id: I741c59f2c1dc50e66bf3cacfc8cb385ec9ec223d
Signed-off-by: Drew Walters <andrew.walters@att.com>

playbooks/airship-airshipctl-build-docs.yaml

@@ -0,0 +1,18 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+- hosts: all
+  become: yes
+  roles:
+    - ensure-python
+    - airshipctl-build-docs
+    - fetch-sphinx-output

roles/airshipctl-build-docs/tasks/main.yaml

@@ -0,0 +1,16 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+- name: Buid airshipctl Docs
+  shell: "make docs"
+  args:
+    chdir: "{{ zuul.project.src_dir }}"

zuul.d/jobs.yaml

@@ -10,6 +10,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+- job:
+    name: airship-airshipctl-build-docs
+    nodeset: airship-airshipctl-single-node
+    run: playbooks/airship-airshipctl-build-docs.yaml
+    vars:
+      sphinx_build_dir: docs/build
+      python_version: 3.7
+
 - job:
     name: airship-airshipctl-lint-unit
     pre-run: playbooks/airship-airshipctl-deploy-docker.yaml
@@ -66,3 +74,4 @@
         - airshipctl-test-configs
       serve_dir: /srv/iso
       serve_port: 8099
+

zuul.d/projects.yaml

@@ -13,12 +13,14 @@
 - project:
     check:
       jobs:
+        - airship-airshipctl-build-docs
         - airship-airshipctl-lint-unit
         - airship-airshipctl-build-image
         - airship-airshipctl-functional-existing-k8s
         - airship-airshipctl-gate-test
     gate:
       jobs:
+        - airship-airshipctl-build-docs
         - airship-airshipctl-lint-unit
         - airship-airshipctl-build-image
         - airship-airshipctl-functional-existing-k8s