openstack/project-config
Code Issues Proposed changes

Merge "Use the new sphinx PTI for special publish jobs"

Browse Source
This commit is contained in:
Zuul 2017-12-19 17:42:06 +00:00 committed by Gerrit Code Review
commit 5a9d5a995f
10 changed files with 136 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
playbooks/project-config/post-tox.yaml Normal file
View File

@ -0,0 +1,3 @@
- hosts: all
roles:
- fetch-tox-output

2
playbooks/python-docs/pre.yaml → playbooks/project-config/pre-tox.yaml
View File

@ -2,6 +2,6 @@
roles: roles:
- role: bindep - role: bindep
bindep_profile: test bindep_profile: test
bindep_dir: "src/{{ zuul.project.canonical_name }}" bindep_dir: "{{ zuul_work_dir|default(omit) }}"
- ensure-tox - ensure-tox
- revoke-sudo - revoke-sudo

5
playbooks/python-docs/run.yaml
View File

@ -1,5 +0,0 @@
- hosts: all
roles:
- role: tox
tox_envlist: venv
tox_extra_args: -vv python setup.py build_sphinx

1
playbooks/python-docs/post-direct.yaml → playbooks/sphinx/post-direct.yaml
View File

@ -1,6 +1,5 @@
- hosts: all - hosts: all
roles: roles:
- fetch-tox-output
- role: write-root-marker - role: write-root-marker
root_marker_dir: "src/{{ zuul.project.canonical_name }}/doc/build/html" root_marker_dir: "src/{{ zuul.project.canonical_name }}/doc/build/html"
when: zuul_success | bool when: zuul_success | bool

1
playbooks/python-docs/post-infra.yaml → playbooks/sphinx/post-infra.yaml
View File

@ -1,7 +1,6 @@
- hosts: all - hosts: all
roles: roles:
- prepare-infra-docs-for-afs - prepare-infra-docs-for-afs
- fetch-tox-output
- role: fetch-sphinx-output - role: fetch-sphinx-output
sphinx_output_src: "src/{{ zuul.project.canonical_name }}/doc/build/html/" sphinx_output_src: "src/{{ zuul.project.canonical_name }}/doc/build/html/"
zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts" zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"

1
playbooks/python-docs/post.yaml → playbooks/sphinx/post.yaml
View File

@ -1,7 +1,6 @@
- hosts: all - hosts: all
roles: roles:
- prepare-docs-for-afs - prepare-docs-for-afs
- fetch-tox-output
- role: fetch-sphinx-output - role: fetch-sphinx-output
sphinx_output_src: "src/{{ zuul.project.canonical_name }}/doc/build/html/" sphinx_output_src: "src/{{ zuul.project.canonical_name }}/doc/build/html/"
zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts" zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"

7
playbooks/sphinx/pre.yaml Normal file
View File

@ -0,0 +1,7 @@
- hosts: all
roles:
- role: bindep
bindep_profile: doc
bindep_dir: "{{ zuul_work_dir|default(omit) }}"
- ensure-sphinx
- revoke-sudo

4
playbooks/sphinx/run.yaml Normal file
View File

@ -0,0 +1,4 @@
- hosts: all
roles:
- install-if-python
- sphinx

155
zuul.d/jobs.yaml
View File

@ -196,10 +196,11 @@
Publishes depending on branch to latest/ (for master), or the Publishes depending on branch to latest/ (for master), or the
basename of the branch like pike (for stable/pike). basename of the branch like pike (for stable/pike).
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/python-docs/run.yaml run: playbooks/project-config/run-tox.yaml
post-run: post-run:
- playbooks/python-docs/post.yaml - playbooks/project-config/post-tox.yaml
- playbooks/sphinx/post.yaml
- playbooks/publish/openstack-afs.yaml - playbooks/publish/openstack-afs.yaml
required-projects: required-projects:
- name: openstack/requirements - name: openstack/requirements
@ -208,6 +209,36 @@
- zuul: openstack-infra/openstack-zuul-jobs - zuul: openstack-infra/openstack-zuul-jobs
vars: vars:
tox_constraints_file: '{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt' tox_constraints_file: '{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt'
tox_envlist: venv
tox_extra_args: -vv python setup.py build_sphinx
secrets:
- secret: afsdocs_secret
name: afs
- job:
name: publish-openstack-sphinx-docs-python3
description: |
Publish the results of the build-openstack-sphinx-docs job to
/afs/.openstack.org/docs/{{ zuul.project.short_name }}.
Builds the docs using Sphinx with Python3.
Publishes depending on branch to latest/ (for master), or the
basename of the branch like pike (for stable/pike).
final: true
pre-run: playbooks/sphinx/pre.yaml
run: playbooks/sphinx/run.yaml
post-run:
- playbooks/sphinx/post.yaml
- playbooks/publish/openstack-afs.yaml
required-projects:
- name: openstack/requirements
roles:
- zuul: openstack-infra/zuul-jobs
- zuul: openstack-infra/openstack-zuul-jobs
vars:
tox_constraints_file: '{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt'
sphinx_python: python3
secrets: secrets:
- secret: afsdocs_secret - secret: afsdocs_secret
name: afs name: afs
@ -220,10 +251,10 @@
Publishing is done from master branch directly without using /latest. Publishing is done from master branch directly without using /latest.
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/sphinx/pre.yaml
run: playbooks/python-docs/run.yaml run: playbooks/sphinx/run.yaml
post-run: post-run:
- playbooks/python-docs/post-direct.yaml - playbooks/sphinx/post-direct.yaml
- playbooks/publish/openstack-afs.yaml - playbooks/publish/openstack-afs.yaml
required-projects: required-projects:
- name: openstack/requirements - name: openstack/requirements
@ -238,14 +269,43 @@
- secret: afsdocs_secret - secret: afsdocs_secret
name: afs name: afs
- job:
name: publish-openstack-sphinx-docs-direct-python3
description: |
Publish the results of the build-openstack-sphinx-docs job to
/afs/.openstack.org/docs/{{ zuul.project.short_name }}
Builds the docs using Sphinx with Python3.
Publishing is done from master branch directly without using /latest.
final: true
pre-run: playbooks/sphinx/pre.yaml
run: playbooks/sphinx/run.yaml
post-run:
- playbooks/sphinx/post-direct.yaml
- playbooks/publish/openstack-afs.yaml
required-projects:
- name: openstack/requirements
roles:
- zuul: openstack-infra/zuul-jobs
- zuul: openstack-infra/openstack-zuul-jobs
vars:
tox_constraints_file: "{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt"
sphinx_python: python3
branches:
- master
secrets:
- secret: afsdocs_secret
name: afs
- job: - job:
name: publish-openstack-contributor-guide name: publish-openstack-contributor-guide
description: | description: |
Publish contributor-guide documents to Publish contributor-guide documents to
https://docs.openstack.org/contributors https://docs.openstack.org/contributors
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/sphinx/pre.yaml
run: playbooks/python-docs/run.yaml run: playbooks/sphinx/run.yaml
post-run: playbooks/publish/contributor-guide-afs.yaml post-run: playbooks/publish/contributor-guide-afs.yaml
roles: roles:
- zuul: openstack-infra/zuul-jobs - zuul: openstack-infra/zuul-jobs
@ -256,19 +316,23 @@
name: afs name: afs
- job: - job:
name: publish-openstack-sphinx-tox-docs name: publish-openstack-sphinx-i18n
description: | description: |
Special publication job for the openstack/i18n project.
Publish the results of the build-openstack-sphinx-docs job to Publish the results of the build-openstack-sphinx-docs job to
/afs/.openstack.org/docs/{{ zuul.project.short_name }}. /afs/.openstack.org/docs/{{ zuul.project.short_name }}.
Publishes depending on branch to latest/ (for master), or the Publishes depending on branch to latest/ (for master), or the
basename of the branch like pike (for stable/pike). basename of the branch like pike (for stable/pike).
This uses the tox "docs" environment for publishing.
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
allowed-projects:
- openstack/i18n
post-run: post-run:
- playbooks/python-docs/post.yaml - playbooks/project-config/post-tox.yaml
- playbooks/sphinx/post.yaml
- playbooks/publish/openstack-afs.yaml - playbooks/publish/openstack-afs.yaml
required-projects: required-projects:
- name: openstack/requirements - name: openstack/requirements
@ -296,7 +360,6 @@
- name: openstack/requirements - name: openstack/requirements
roles: roles:
- zuul: openstack-infra/zuul-jobs - zuul: openstack-infra/zuul-jobs
- zuul: openstack-infra/openstack-zuul-jobs
vars: vars:
constraints_file: '{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt' constraints_file: '{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt'
secrets: secrets:
@ -309,8 +372,8 @@
Publish OpenStack specs to static.openstack.org Publish OpenStack specs to static.openstack.org
specs/{{ zuul.project.short_name }} specs/{{ zuul.project.short_name }}
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/sphinx/pre.yaml
run: playbooks/python-docs/run.yaml run: playbooks/sphinx/run.yaml
post-run: playbooks/publish/openstack-specs.yaml post-run: playbooks/publish/openstack-specs.yaml
required-projects: required-projects:
- name: openstack/requirements - name: openstack/requirements
@ -327,7 +390,7 @@
description: | description: |
Publish OpenStack specs site to static.openstack.org specs/ Publish OpenStack specs site to static.openstack.org specs/
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
post-run: playbooks/publish/openstack-specs-site.yaml post-run: playbooks/publish/openstack-specs-site.yaml
allowed-projects: allowed-projects:
@ -346,10 +409,10 @@
Publish the results of the openstack-build-sphinx-docs job to Publish the results of the openstack-build-sphinx-docs job to
/afs/.openstack.org/infra/{{ zuul.project.short_name }} /afs/.openstack.org/infra/{{ zuul.project.short_name }}
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/sphinx/pre.yaml
run: playbooks/python-docs/run.yaml run: playbooks/sphinx/run.yaml
post-run: post-run:
- playbooks/python-docs/post-infra.yaml - playbooks/sphinx/post-infra.yaml
- playbooks/publish/infra-afs.yaml - playbooks/publish/infra-afs.yaml
roles: roles:
- zuul: openstack-infra/zuul-jobs - zuul: openstack-infra/zuul-jobs
@ -358,15 +421,37 @@
- secret: afsdocs_secret - secret: afsdocs_secret
name: afs name: afs
- job:
name: publish-openstack-sphinx-docs-infra-python3
description: |
Publish the results of the openstack-build-sphinx-docs job to
/afs/.openstack.org/infra/{{ zuul.project.short_name }}
Builds the docs using Sphinx with Python3.
final: true
pre-run: playbooks/sphinx/pre.yaml
run: playbooks/sphinx/run.yaml
post-run:
- playbooks/sphinx/post-infra.yaml
- playbooks/publish/infra-afs.yaml
vars:
sphinx_python: python3
roles:
- zuul: openstack-infra/zuul-jobs
- zuul: openstack-infra/openstack-zuul-jobs
secrets:
- secret: afsdocs_secret
name: afs
- job: - job:
name: publish-infra-manual name: publish-infra-manual
description: | description: |
Publish the Infra Manual to /afs/.openstack.org/docs/infra/manual Publish the Infra Manual to /afs/.openstack.org/docs/infra/manual
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/sphinx/pre.yaml
run: playbooks/python-docs/run.yaml run: playbooks/sphinx/run.yaml
post-run: post-run:
- playbooks/python-docs/post-infra.yaml - playbooks/sphinx/post-infra.yaml
- playbooks/publish/infra-manual.yaml - playbooks/publish/infra-manual.yaml
allowed-projects: allowed-projects:
- openstack-infra/infra-manual - openstack-infra/infra-manual
@ -383,7 +468,7 @@
Publish OpenStack Service Types Authority to Publish OpenStack Service Types Authority to
https://service-types.openstack.org https://service-types.openstack.org
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
post-run: playbooks/publish/service-types.yaml post-run: playbooks/publish/service-types.yaml
allowed-projects: allowed-projects:
@ -401,7 +486,7 @@
description: | description: |
Publish the infrastructure documentation index Publish the infrastructure documentation index
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
post-run: playbooks/publish/infra-index.yaml post-run: playbooks/publish/infra-index.yaml
allowed-projects: allowed-projects:
@ -420,7 +505,7 @@
description: | description: |
Publish the publication index Publish the publication index
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/publications-index/run.yaml run: playbooks/publications-index/run.yaml
post-run: playbooks/publish/publications-index.yaml post-run: playbooks/publish/publications-index.yaml
allowed-projects: allowed-projects:
@ -439,7 +524,7 @@
description: | description: |
Publish one publication from openstack-infra/publications Publish one publication from openstack-infra/publications
final: true final: true
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/publications/run.yaml run: playbooks/publications/run.yaml
post-run: playbooks/publish/publications.yaml post-run: playbooks/publish/publications.yaml
allowed-projects: allowed-projects:
@ -486,9 +571,9 @@
- job: - job:
name: base-publish-static name: base-publish-static
description: | description: |
Base job for job that publish content to static.openstack.org. Base job for jobs that publish content to static.openstack.org.
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/sphinx/pre.yaml
run: playbooks/python-docs/run.yaml run: playbooks/sphinx/run.yaml
- job: - job:
name: publish-static name: publish-static
@ -587,7 +672,7 @@
Note that this build job does not create a root-marker file, Note that this build job does not create a root-marker file,
this has to be done by scripts called from tox. this has to be done by scripts called from tox.
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
roles: roles:
- zuul: openstack-infra/zuul-jobs - zuul: openstack-infra/zuul-jobs
@ -658,7 +743,7 @@
description: | description: |
Publish api-guide document to Publish api-guide document to
https://developer.openstack.org/api-guide. https://developer.openstack.org/api-guide.
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
post-run: playbooks/publish/api-guide.yaml post-run: playbooks/publish/api-guide.yaml
roles: roles:
@ -678,7 +763,7 @@
description: | description: |
Publish api-ref document to Publish api-ref document to
https://developer.openstack.org/api-ref. https://developer.openstack.org/api-ref.
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
post-run: playbooks/publish/api-ref.yaml post-run: playbooks/publish/api-ref.yaml
roles: roles:
@ -698,7 +783,7 @@
description: | description: |
Publish placement-api-ref document to Publish placement-api-ref document to
https://developer.openstack.org/api-ref/placement. https://developer.openstack.org/api-ref/placement.
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
post-run: playbooks/publish/placement-api-ref.yaml post-run: playbooks/publish/placement-api-ref.yaml
roles: roles:
@ -718,7 +803,7 @@
description: | description: |
Publish install-guide document to Publish install-guide document to
https://docs.openstack.org/project-install-guide/ https://docs.openstack.org/project-install-guide/
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
post-run: playbooks/publish/install-guide.yaml post-run: playbooks/publish/install-guide.yaml
roles: roles:
@ -739,7 +824,7 @@
description: | description: |
Publish deploy-guide document to Publish deploy-guide document to
https://docs.openstack.org/project-deploy-guide/ https://docs.openstack.org/project-deploy-guide/
pre-run: playbooks/python-docs/pre.yaml pre-run: playbooks/project-config/pre-tox.yaml
run: playbooks/project-config/run-tox.yaml run: playbooks/project-config/run-tox.yaml
post-run: playbooks/publish/deploy-guide.yaml post-run: playbooks/publish/deploy-guide.yaml
roles: roles:

2
zuul.d/projects.yaml
View File

@ -7216,7 +7216,7 @@
- openstack-tox-pep8 - openstack-tox-pep8
post: post:
jobs: jobs:
- publish-openstack-sphinx-tox-docs - publish-openstack-sphinx-i18n
- project: - project:
name: openstack/i18n-specs name: openstack/i18n-specs