From 7716b93018b5efbebd86fa9258fdb2f861160fbb Mon Sep 17 00:00:00 2001
From: Monty Taylor <mordred@inaugust.com>
Date: Thu, 5 Oct 2017 10:06:36 -0500
Subject: [PATCH] Put doc build jobs into doc publication project-template

They aren't python specific, and it's important to run them in check and
gate if one is intending to run them in post/release.

Add a template for neutron, because of the neutron needing neutron
issue.

Add a template for just building and not publishing.

Update the template for docs-on-readthedocs for projects who want to
follow the docs PTI but aren't official and and so publish to readthedocs.

Change-Id: I8f6a0b1401099def47bb349c5c2453429bd19085
---
 zuul.d/project-templates.yaml | 92 ++++++++++++++++++++++++++---------
 1 file changed, 70 insertions(+), 22 deletions(-)

diff --git a/zuul.d/project-templates.yaml b/zuul.d/project-templates.yaml
index 4099f8dc..d6b07d4c 100644
--- a/zuul.d/project-templates.yaml
+++ b/zuul.d/project-templates.yaml
@@ -1,13 +1,63 @@
 # Shared project-templates specific to the OpenStack Project
 
+- project-template:
+    name: build-openstack-sphinx-docs
+    description: |
+      Runs normal OpenStack PTI doc build without publication jobs.
+    check:
+      jobs:
+        - build-openstack-sphinx-docs
+    gate:
+      jobs:
+        - build-openstack-sphinx-docs
+
 - project-template:
     name: publish-openstack-sphinx-docs
+    description: |
+      Runs normal OpenStack PTI doc build and publication jobs.
+    check:
+      jobs:
+        - build-openstack-sphinx-docs
+    gate:
+      jobs:
+        - build-openstack-sphinx-docs
     post:
       jobs:
         - publish-openstack-sphinx-docs
 
+- project-template:
+    name: publish-openstack-sphinx-docs-neutron
+    description: |
+      Runs normal OpenStack PTI doc build and publication jobs with neutron
+      added to required-projects for the various networking- projects that
+      need that.
+    check:
+      jobs:
+        - build-openstack-sphinx-docs:
+            required-projects:
+              - openstack/neutron
+    gate:
+      jobs:
+        - build-openstack-sphinx-docs:
+            required-projects:
+              - openstack/neutron
+    post:
+      jobs:
+        - publish-openstack-sphinx-docs:
+            required-projects:
+              - openstack/neutron
+
 - project-template:
     name: publish-openstack-sphinx-docs-infra
+    description: |
+      Runs normal OpenStack PTI build jobs and publishes to the Infra
+      docs location.
+    check:
+      jobs:
+        - build-openstack-sphinx-docs
+    gate:
+      jobs:
+        - build-openstack-sphinx-docs
     post:
       jobs:
         - publish-openstack-sphinx-docs-infra
@@ -141,12 +191,10 @@
     name: openstack-python-jobs
     check:
       jobs:
-        - build-openstack-sphinx-docs
         - openstack-tox-pep8
         - openstack-tox-py27
     gate:
       jobs:
-        - build-openstack-sphinx-docs
         - openstack-tox-pep8
         - openstack-tox-py27
     post:
@@ -161,9 +209,6 @@
       due to how the tox_install.sh zuul-cloner's neutron for them.
     check:
       jobs:
-        - build-openstack-sphinx-docs:
-            required-projects:
-              - openstack/neutron
         - openstack-tox-pep8:
             required-projects:
               - openstack/neutron
@@ -172,9 +217,6 @@
               - openstack/neutron
     gate:
       jobs:
-        - build-openstack-sphinx-docs:
-            required-projects:
-              - openstack/neutron
         - openstack-tox-pep8:
             required-projects:
               - openstack/neutron
@@ -249,29 +291,35 @@
     name: openstack-python-jobs-trusty
     check:
       jobs:
-        - build-openstack-sphinx-docs:
-            nodeset: ubuntu-trusty
         - openstack-tox-pep8:
             nodeset: ubuntu-trusty
         - openstack-tox-py27:
             nodeset: ubuntu-trusty
     gate:
       jobs:
-        - build-openstack-sphinx-docs:
-            nodeset: ubuntu-trusty
         - openstack-tox-pep8:
             nodeset: ubuntu-trusty
         - openstack-tox-py27:
             nodeset: ubuntu-trusty
 
 - project-template:
-     name: docs-on-readthedocs
-     post:
-       jobs:
-         - trigger-readthedocs
-     pre-release:
-       jobs:
-         - trigger-readthedocs
-     release:
-       jobs:
-         - trigger-readthedocs
+    name: docs-on-readthedocs
+    description: |
+      Runs normal OpenStack PTI build jobs but publishes to readthedocs
+      instead of docs.openstack.org. This is intended for projects that are
+      aiming to follow the PTI but are not official.
+    check:
+      jobs:
+        - build-openstack-sphinx-docs
+    gate:
+      jobs:
+        - build-openstack-sphinx-docs
+    post:
+      jobs:
+        - trigger-readthedocs
+    pre-release:
+      jobs:
+        - trigger-readthedocs
+    release:
+      jobs:
+        - trigger-readthedocs