From fc6d7bcfa4026fd9ddc597d3db0d0a691333fb85 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sat, 25 Aug 2018 10:20:40 +0200
Subject: [PATCH] Fix some doc publishing jobs

Fix wrong parent of job publish-openstack-tox-docs-direct.

Fix description for zuul-docs-publish.

Move common post-run playbook to parent for publish-openstack-tox-docs.

Change contributor-guide publishing to tox-docs.

Remove publish-sphinx-docs-base, it's unused. Fold it into its only
user.

Remove build-sphinx-docs from jenkins-job-builder, we switched to
tox-docs and the job passes, so no need to make it non-voting in check
only but voting in gate.

For log-classify: Use build-tox-docs instead of sphinx - the repo has no
content, so let's use the proper job directly.

Change-Id: I0b06818e26773560df13ae6eb2d9964d5e6bf43a
---
 zuul.d/jobs.yaml      | 52 +++++++++++++++++--------------------------
 zuul.d/projects.yaml  |  4 +---
 zuul.d/zuul-jobs.yaml |  2 +-
 3 files changed, 23 insertions(+), 35 deletions(-)

diff --git a/zuul.d/jobs.yaml b/zuul.d/jobs.yaml
index f04b8a446e..d46a47846e 100644
--- a/zuul.d/jobs.yaml
+++ b/zuul.d/jobs.yaml
@@ -268,10 +268,12 @@
       - README.rst
 
 - job:
-    name: publish-sphinx-docs-base
+    name: publish-openstack-sphinx-docs-base
     description: |
       Base job for publishing sphinx documentation to
-      /afs/.openstack.org/docs/. Does not use constraints.
+      /afs/.openstack.org/docs/.
+
+      This job is obsolete, use ``publish-openstack-tox-docs-base`` instead.
     abstract: true
     protected: true
     pre-run:
@@ -279,23 +281,14 @@
     run: playbooks/sphinx/run.yaml
     post-run:
       - playbooks/publish/openstack-afs.yaml
+    required-projects:
+      - name: openstack/requirements
     roles:
       - zuul: openstack-infra/zuul-jobs
       - zuul: openstack-infra/openstack-zuul-jobs
     secrets:
       - secret: afsdocs_secret
         name: afs
-
-- job:
-    name: publish-openstack-sphinx-docs-base
-    parent: publish-sphinx-docs-base
-    description: |
-      Base job for publishing sphinx documentation to
-      /afs/.openstack.org/docs/.
-    abstract: true
-    protected: true
-    required-projects:
-      - name: openstack/requirements
     vars:
       constraints_file: '{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt'
 
@@ -335,19 +328,6 @@
     branches:
       - master
 
-- job:
-    name: publish-openstack-contributor-guide
-    parent: publish-openstack-sphinx-docs-base
-    description: |
-      Publish contributor-guide documents to
-      https://docs.openstack.org/contributors
-    final: true
-    post-run:
-      - playbooks/publish/contributor-guide-afs.yaml
-    branches: master
-    vars:
-      afs_subpath: "/contributors"
-
 - job:
     name: publish-openstack-tox-docs-base
     description: |
@@ -361,6 +341,7 @@
     pre-run: playbooks/project-config/pre-tox.yaml
     run: playbooks/project-config/run-tox.yaml
     post-run:
+      - playbooks/project-config/post-tox.yaml
       - playbooks/publish/openstack-afs.yaml
     required-projects:
       - name: openstack/requirements
@@ -387,7 +368,6 @@
       basename of the branch like pike (for stable/pike).
     final: true
     post-run:
-      - playbooks/project-config/post-tox.yaml
       - playbooks/sphinx/post.yaml
     required-projects:
       - name: openstack/requirements
@@ -396,7 +376,7 @@
 
 - job:
     name: publish-openstack-tox-docs-direct
-    parent: publish-openstack-sphinx-docs-base
+    parent: publish-openstack-tox-docs-base
     description: |
       Publish the results of the openstack-tox-docs job to
       /afs/.openstack.org/docs/{{ zuul.project.short_name }}
@@ -404,11 +384,23 @@
       Publishing is done from master branch directly without using /latest.
     final: true
     post-run:
-      - playbooks/project-config/post-tox.yaml
       - playbooks/sphinx/post-direct.yaml
     branches:
       - master
 
+- job:
+    name: publish-openstack-contributor-guide
+    parent: publish-openstack-tox-docs-base
+    description: |
+      Publish contributor-guide documents to
+      https://docs.openstack.org/contributors
+    final: true
+    post-run:
+      - playbooks/publish/contributor-guide-afs.yaml
+    branches: master
+    vars:
+      afs_subpath: "/contributors"
+
 - job:
     name: publish-openstack-releasenotes-base
     description: |
@@ -512,7 +504,6 @@
       /afs/.openstack.org/infra/{{ zuul.project.short_name }}
     final: true
     post-run:
-      - playbooks/project-config/post-tox.yaml
       - playbooks/sphinx/post-infra.yaml
     vars:
       afs_subpath: "/infra/{{ zuul.project.short_name }}"
@@ -524,7 +515,6 @@
       Publish the Infra Manual to /afs/.openstack.org/docs/infra/manual
     final: true
     post-run:
-      - playbooks/project-config/post-tox.yaml
       - playbooks/sphinx/post-infra.yaml
     allowed-projects:
       - openstack-infra/infra-manual
diff --git a/zuul.d/projects.yaml b/zuul.d/projects.yaml
index a44e91ac11..cd12221778 100644
--- a/zuul.d/projects.yaml
+++ b/zuul.d/projects.yaml
@@ -609,8 +609,6 @@
     check:
       jobs:
         - tox-cover
-        - build-sphinx-docs:
-            voting: false
     post:
       jobs:
         - tox-cover
@@ -656,7 +654,7 @@
 - project:
     name: openstack-infra/log-classify
     templates:
-      - build-openstack-sphinx-docs
+      - build-tox-docs
     check:
       jobs:
         - openstack-tox-pep8
diff --git a/zuul.d/zuul-jobs.yaml b/zuul.d/zuul-jobs.yaml
index 0d8c37354e..d8b30ca5de 100644
--- a/zuul.d/zuul-jobs.yaml
+++ b/zuul.d/zuul-jobs.yaml
@@ -19,7 +19,7 @@
       Publish the results of a sphinx build to
       /afs/.openstack.org/project/zuul-ci.org/www/docs/{{ zuul.project.short_name }}
 
-      Builds the docs using Sphinx with Python3.
+      Builds the docs using ``tox -e docs``.
     # Set final to avoid override of afs_subpath variable.
     final: true
     allowed-projects: