Cleanup jobs and config

Use promote jobs for all publishing jobs, they work fine. We don't use checkbuild/checklang anymore, remove it. Keep checkbuild job until we have renamed training-guides to use the new job. Change-Id: I882fd90f07987358cd55e3a04a8f7ad0c746ce80
2 years ago · c1cc9cae1f
--- a/.zuul.yaml
+++ b/.zuul.yaml
@ -35,12 +35,21 @@
    parent: build-tox-manuals-base
    description: |
      Build manuals using "publishdocs" tox environment.

      This will be removed now after all users are updated.
    vars:
      tox_envlist: publishdocs

 - job:
    # TODO(AJaeger): Rename to publishlang
    name: build-tox-manuals-checklang
    name: build-tox-manuals-publishdocs
    parent: build-tox-manuals-base
    description: |
      Build manuals using "publishdocs" tox environment.
    vars:
      tox_envlist: publishdocs

 - job:
    name: build-tox-manuals-publishlang
    parent: build-tox-manuals-base
    description: |
      Build translated manuals using "publishlang" tox environment.
@ -63,11 +72,11 @@
    check:
      jobs:
        - openstack-tox-linters
        - build-tox-manuals-checkbuild
        - build-tox-manuals-publishdocs
    gate:
      jobs:
        - openstack-tox-linters
        - build-tox-manuals-checkbuild
        - build-tox-manuals-publishdocs
    promote:
      jobs:
        - promote-openstack-manuals
@ -79,14 +88,13 @@
      This will publish content to developer.openstack.org.
    check:
      jobs:
        - build-tox-manuals-checkbuild
        - build-tox-manuals-publishdocs
    gate:
      jobs:
        - build-tox-manuals-checkbuild
    post:
        - build-tox-manuals-publishdocs
    promote:
      jobs:
        - publish-openstack-manuals-developer

        - promote-openstack-manuals-developer

 - project-template:
    name: openstack-manuals-build-translation
@ -94,13 +102,13 @@
      Runs jobs to build translated documents.
    check:
      jobs:
        - build-tox-manuals-checklang
        - build-tox-manuals-publishlang
    gate:
      jobs:
        - build-tox-manuals-checklang
    post:
        - build-tox-manuals-publishlang
    promote:
      jobs:
        - publish-openstack-manuals-lang
        - promote-openstack-manuals-lang

 # Configuration for this repository, determines which jobs to run.
 - project:
--- a/README.rst
+++ b/README.rst
@ -85,9 +85,9 @@ CI jobs.

 If you like to run individual tests, run:

 * ``tox -e checkbuild`` - to actually build the manual; this also generates a
 * ``tox -e publishdocs`` - to actually build the manual; this also generates a
  directory ``publish-docs`` that contains the built files for inspection
 * ``tox -e checklang`` - to build translated manuals
 * ``tox -e publishlang`` - to build translated manuals
 * ``tox -e linters`` - to run the niceness tests, for example, to see extra
  whitespaces
 * ``tox -e linkcheck`` - to run the tests for working remote URLs
--- a/doc/doc-contrib-guide/source/doc-tools/template-generator.rst
+++ b/doc/doc-contrib-guide/source/doc-tools/template-generator.rst
@ -465,7 +465,7 @@ There are two commands useful for testing the build locally:

 .. code-block:: console

   $ tox -e checkbuild
   $ tox -e publishdocs

 and

--- a/doc/doc-contrib-guide/source/docs-builds.rst
+++ b/doc/doc-contrib-guide/source/docs-builds.rst
@ -197,11 +197,11 @@ that do automatic testing of patches.
 For openstack-manuals, the current jobs are:

 * openstack-tox-linters
 * build-tox-manual-checkbuild
 * build-tox-manual-checklang
 * build-tox-manual-publishdocs
 * build-tox-manual-publishlang

 Checklang job
 -------------
 Publishlang job
 ---------------

 We only gate on manual/language combinations that are translated
 sufficiently.
@ -212,7 +212,7 @@ sufficiently.
  <https://bugs.launchpad.net/openstack-i18n>`_.

 If you want to manually run this check in your clone of openstack-manuals, use
 the checklang environment (:command:`tox -e checklang`).
 the publishlang environment (:command:`tox -e publishlang`).

 .. _docs_builds_eol:

--- a/doc/doc-contrib-guide/source/docs-review.rst
+++ b/doc/doc-contrib-guide/source/docs-review.rst
@ -60,9 +60,9 @@ Once done, follow the steps below to submit a patch review.
   you can also highlight the line or word in question, and press 'c'
   on your keyboard, which enables commenting directly on that line or word.
   Click :guilabel:`Save` button once you write a draft of your comment.
 #. In the :guilabel:`Zuul check` section, click the ``checkbuild``
 #. In the :guilabel:`Zuul check` section, click the ``publishdocs``
   gate link (for the openstack-manuals, it is called
   ``build-tox-manuals-checkbuild``) and review the built manuals to see how
   ``build-tox-manuals-publishdocs``) and review the built manuals to see how
   the change will look on the web page. For a new patch, it takes some time
   before the OpenStack CI system checks appear on the Gerrit page.
   You can also :ref:`build the patch locally <docs_builds_locally>`
--- a/doc/doc-contrib-guide/source/release/taskdetail.rst
+++ b/doc/doc-contrib-guide/source/release/taskdetail.rst
@ -134,7 +134,7 @@ Make the following changes in the **openstack-manuals** repository:
   templates for the release being completed will use the data from
   the file created in the previous step.

 #. Test the build locally with ``tox -e checkbuild``.
 #. Test the build locally with ``tox -e publishdocs``.

   If any project links are missing and cause the template generator
   to fail, set the flags to disable linking to those docs. For
--- a/tools/test.sh
+++ b/tools/test.sh
@ -6,7 +6,7 @@ else
    output=publish-docs/html/
 fi

 .tox/checkbuild/bin/python tools/www-generator.py --verbose --source-directory www/ \
 .tox/publishdocs/bin/python tools/www-generator.py --verbose --source-directory www/ \
        --output-directory $output $@

 if [[ $? -eq 0 ]]; then
@ -16,4 +16,4 @@ fi
 # to include the file.
 #mv publish-docs/html/www/www-index.html publish-docs/html/www-index.html

 .tox/checkbuild/bin/whereto $output/.htaccess $output/redirect-tests.txt
 .tox/publishdocs/bin/whereto $output/.htaccess $output/redirect-tests.txt
--- a/tox.ini
+++ b/tox.ini
@ -1,6 +1,6 @@
 [tox]
 minversion = 2.0
 envlist = linters,checkbuild
 envlist = linters,publishdocs
 skipsdist = True

 [testenv]
@ -29,11 +29,6 @@ commands =
  doc8 doc
  {toxinidir}/tools/glossary-sort.sh

 [testenv:checkbuild]
 commands =
  {toxinidir}/tools/publishdocs.sh build
  whereto publish-docs/html/www/.htaccess publish-docs/html/www/redirect-tests.txt

 [testenv:docs]
 commands =
  {toxinidir}/tools/build-all-rst.sh
@ -58,16 +53,6 @@ commands =
  whereto publish-docs/html/.htaccess publish-docs/html/redirect-tests.txt
  rm publish-docs/html/redirect-tests.txt

 [testenv:checklang]
 whitelist_externals = doc-tools-check-languages
 commands =
  doc-tools-check-languages doc-tools-check-languages.conf test all
  # Move from publish-docs to publish-docs/html
  # TODO(AJaeger): Remove once openstack-doc-tools is updated
  mkdir publish-docs-new
  mv publish-docs publish-docs-new/html
  mv publish-docs-new publish-docs

 [testenv:buildlang]
 # Run as "tox -e buildlang -- $LANG"
 whitelist_externals = doc-tools-check-languages