openstack-manuals/.zuul.yaml
Andreas Jaeger 64e109dabb Add descriptions to zuul.yaml
Add missing descriptions to the jobs in .zuul.yaml.

Change-Id: Ib84a3e34e4c25a1f565a506f3229453a0d997be3
2017-12-16 16:33:42 +01:00

125 lines
3.3 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
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 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: openstack-tox
success-url: publish-docs/
post-run: playbooks/build-manuals-tox/post.yaml
roles:
- zuul: openstack-infra/zuul-jobs
vars:
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:
name: build-tox-manuals-checkbuild
parent: build-tox-manuals
description: |
Build manuals using "checkbuild" tox environment.
vars:
tox_envlist: checkbuild
- job:
name: build-tox-manuals-checklang
parent: build-tox-manuals
description: |
Build translated manuals using "checklang" tox environment.
vars:
tox_envlist: checklang
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:
- publish-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:
- openstack-tox-linters
- build-tox-manuals-checkbuild
gate:
jobs:
- openstack-tox-linters
- 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
- project-template:
name: openstack-manuals-developer-build-translation
description: |
Runs jobs to build translated documents.
This will publish content to developer.openstack.org.
check:
jobs:
- build-tox-manuals-checklang
gate:
jobs:
- build-tox-manuals-checklang
post:
jobs:
- publish-openstack-manuals-developer-lang
# Configuration for this repository, determines which jobs to run.
- project:
name: openstack/openstack-manuals
templates:
- openstack-manuals-build-translation
- openstack-manuals-jobs