Andreas Jaeger 99920e8a49 Use opendev-tox-docs job
Switch our docs job to use opendev-tox-docs job as base so that we can
publish later the content from gate directly (via promote queue) and do
not need to rebuild in post again.

Use the new promote-openstack-manuals job as first step in using promote
publishing. The other publish jobs will be replaced separately.

Use for building now publishdocs/publishlang so that we have exactly
the same content in check and gate - and in the published website.
For this, update tox.ini and publish script.

Also, do not publish project-data.

Depends-On: https://review.opendev.org/676489
Change-Id: I91f22173a4a6ed421f339833c486a31fd319dba3
2019-08-15 21:45:02 +02:00

117 lines
3.1 KiB
YAML

# Shared Zuul v3 definitions for OpenStack CI.
# These jobs are used in api-site, openstack-manuals, and security-doc
# repositories.
- job:
name: build-tox-manuals-base
abstract: true
description: |
Base job to build manual related documents. These build jobs
invoke a tox command and expect the published content to be in
publish-docs/html directory. This content is published on the root of
the website.
Note that this build job does not create a root-marker file,
this has to be done by scripts called from tox.
parent: opendev-tox-docs
nodeset: ubuntu-bionic
success-url: publish-docs/html/
roles:
- zuul: zuul/zuul-jobs
vars:
sphinx_build_dir: 'publish-docs'
tox_environment:
# The tox job writes the root-marker file directly and thus
# needs the following variables set:
ZUUL_PROJECT: '{{ zuul.project.name }}'
ZUUL_BRANCH: '{{ zuul.branch }}'
ZUUL_UUID: '{{ zuul.build }}'
ZUUL_NEWREF: '{{ zuul.ref }}'
- job:
# TODO(AJaeger): Rename to publishdocs
name: build-tox-manuals-checkbuild
parent: build-tox-manuals-base
description: |
Build manuals using "publishdocs" tox environment.
vars:
tox_envlist: publishdocs
- job:
# TODO(AJaeger): Rename to publishlang
name: build-tox-manuals-checklang
parent: build-tox-manuals-base
description: |
Build translated manuals using "publishlang" tox environment.
vars:
tox_envlist: publishlang
files:
- ^.*\.po$
- ^.*\.pot$
- ^.*requirements.txt$
- ^bindep.txt
- ^doc-tools-check-languages.conf
- ^tools/
- ^tox.ini
# Templates to easily group jobs.
- project-template:
name: openstack-manuals-jobs
description: |
Runs jobs for non-translated documents.
check:
jobs:
- openstack-tox-linters
- build-tox-manuals-checkbuild
gate:
jobs:
- openstack-tox-linters
- build-tox-manuals-checkbuild
post:
jobs:
- promote-openstack-manuals
- project-template:
name: openstack-manuals-developer-jobs
description: |
Runs jobs for non-translated documents.
This will publish content to developer.openstack.org.
check:
jobs:
- build-tox-manuals-checkbuild
gate:
jobs:
- build-tox-manuals-checkbuild
post:
jobs:
- publish-openstack-manuals-developer
- project-template:
name: openstack-manuals-build-translation
description: |
Runs jobs to build translated documents.
check:
jobs:
- build-tox-manuals-checklang
gate:
jobs:
- build-tox-manuals-checklang
post:
jobs:
- publish-openstack-manuals-lang
# Configuration for this repository, determines which jobs to run.
- project:
templates:
- openstack-manuals-build-translation
- openstack-manuals-jobs
- release-notes-jobs-python3
post:
jobs:
- propose-updates:
vars:
update_target: openstack-manuals