83e5e0a809
Adds r/stx.9.0 to the list of branches to promote for StarlingX docs. Change-Id: I82411948cfcfed375f2a5fb6224d515929015ada Signed-off-by: Ron Stone <ronald.stone@windriver.com>
189 lines
5.4 KiB
YAML
189 lines
5.4 KiB
YAML
- job:
|
|
name: publish-stx-tox-base
|
|
description: |
|
|
Abstract base job to publish the results of a sphinx build to
|
|
/afs/.openstack.org/project/starlingx.io/www
|
|
|
|
Builds the docs using ``tox -e docs``.
|
|
# This job is protected-abstract because it sets the afs_subpath
|
|
# variable; it is not safe to let that be overridden in an
|
|
# untrusted job because it would allow writing outside of the
|
|
# project's directory on the production doc site.
|
|
abstract: true
|
|
protected: true
|
|
pre-run: playbooks/project-config/pre-tox.yaml
|
|
run: playbooks/project-config/run-tox.yaml
|
|
post-run:
|
|
- playbooks/project-config/post-tox.yaml
|
|
- playbooks/sphinx/post-infra.yaml
|
|
- playbooks/publish/starlingx-afs.yaml
|
|
roles:
|
|
- zuul: zuul/zuul-jobs
|
|
- zuul: openstack/openstack-zuul-jobs
|
|
secrets:
|
|
- secret: afsdocs_secret
|
|
name: afs
|
|
vars:
|
|
tox_envlist: docs
|
|
|
|
- job:
|
|
name: publish-stx-tox
|
|
parent: publish-stx-tox-base
|
|
description: |
|
|
Publish the results of a sphinx build to
|
|
/afs/.openstack.org/project/starlingx.io/www/{{ zuul.project.short_name }}
|
|
|
|
Builds the docs using ``tox -e docs``.
|
|
# Set final to avoid override of afs_subpath variable.
|
|
final: true
|
|
vars:
|
|
afs_subpath: "/{{ zuul.project.short_name }}"
|
|
|
|
- job:
|
|
name: promote-stx-api-ref
|
|
parent: opendev-promote-docs-base
|
|
description: |
|
|
Publish api-ref document to
|
|
/afs/.openstack.org/project/starlingx.io/www/api-ref{{ zuul.project.short_name }}
|
|
|
|
This job is run in a promote pipeline to publish documents built
|
|
in the gate pipeline.
|
|
# We only publish the master branch, so no need to run
|
|
# for changes on other branches.
|
|
branches: master
|
|
final: true
|
|
vars:
|
|
download_artifact_job: build-openstack-api-ref
|
|
roles:
|
|
- zuul: zuul/zuul-jobs
|
|
- zuul: openstack/openstack-zuul-jobs
|
|
secrets:
|
|
- secret: afsdocs_secret-stx-apiref
|
|
name: afs
|
|
pass-to-parent: true
|
|
|
|
- job:
|
|
name: promote-stx-tox-docs
|
|
parent: opendev-promote-docs-base
|
|
description: |
|
|
Promote content from openstack-tox-docs job for starlingx.
|
|
|
|
Publish the results of a sphinx build to
|
|
/afs/.openstack.org/project/starlingx.io/www
|
|
|
|
Publishes depending on branch to / (for master), or the
|
|
name of the branch.
|
|
final: true
|
|
vars:
|
|
download_artifact_job: openstack-tox-docs
|
|
secrets:
|
|
- secret: afsdocs_secret-stx-tox-docs
|
|
name: afs
|
|
pass-to-parent: true
|
|
|
|
- job:
|
|
name: promote-stx-tox-docs-site
|
|
parent: opendev-promote-docs-base
|
|
description: |
|
|
Promote content from openstack-tox-docs job for
|
|
starlingx/doc repository only.
|
|
|
|
Publish the results of a sphinx build to
|
|
/afs/.openstack.org/project/starlingx.io/www
|
|
|
|
final: true
|
|
vars:
|
|
download_artifact_job: openstack-tox-docs
|
|
# add older release branches as desired
|
|
branches:
|
|
- master
|
|
- r/stx.5.0
|
|
- r/stx.6.0
|
|
- r/stx.7.0
|
|
- r/stx.8.0
|
|
- r/stx.9.0
|
|
allowed-projects:
|
|
- starlingx/docs
|
|
secrets:
|
|
- secret: afsdocs_secret-stx-tox-docs-site
|
|
name: afs
|
|
pass-to-parent: true
|
|
|
|
- job:
|
|
name: publish-stx-api-ref
|
|
parent: publish-stx-tox-base
|
|
description: |
|
|
Publish the results of a sphinx api-ref build to
|
|
/afs/.openstack.org/project/starlingx.io/www/api-ref{{ zuul.project.short_name }}
|
|
|
|
Builds the docs using ``tox -e api-ref``.
|
|
# Set final to avoid override of afs_subpath variable.
|
|
final: true
|
|
branches: master
|
|
vars:
|
|
afs_subpath: "/api-ref/{{ zuul.project.short_name }}"
|
|
sphinx_build_dir: api-ref/build
|
|
tox_envlist: api-ref
|
|
|
|
- job:
|
|
name: publish-stx-election
|
|
parent: publish-stx-tox-base
|
|
description: |
|
|
Publish the results of a sphinx build to
|
|
/afs/.openstack.org/project/starlingx.io/www/election
|
|
|
|
Builds the docs using ``tox -e docs``.
|
|
# Set final to avoid override of afs_subpath variable.
|
|
final: true
|
|
allowed-projects:
|
|
- starlingx/election
|
|
vars:
|
|
afs_subpath: "/election"
|
|
|
|
- job:
|
|
name: publish-stx-governance
|
|
parent: publish-stx-tox-base
|
|
description: |
|
|
Publish the results of a sphinx build to
|
|
/afs/.openstack.org/project/starlingx.io/www/governance
|
|
|
|
Builds the docs using ``tox -e docs``.
|
|
# Set final to avoid override of afs_subpath variable.
|
|
final: true
|
|
allowed-projects:
|
|
- starlingx/governance
|
|
vars:
|
|
afs_subpath: "/governance"
|
|
|
|
- job:
|
|
name: publish-stx-releasenotes
|
|
parent: publish-stx-tox-base
|
|
description: |
|
|
Publish the results of a sphinx api-ref build to
|
|
/afs/.openstack.org/project/starlingx.io/www/releasenotes/{{ zuul.project.short_name }}
|
|
|
|
Builds the docs using ``tox -e releasenotes``.
|
|
# Set final to avoid override of afs_subpath variable.
|
|
final: true
|
|
# reno always works off master
|
|
override-branch: master
|
|
vars:
|
|
afs_subpath: "/releasenotes/{{ zuul.project.short_name }}"
|
|
sphinx_build_dir: releasenotes/build
|
|
tox_envlist: releasenotes
|
|
|
|
- job:
|
|
name: publish-stx-specs
|
|
parent: publish-stx-tox-base
|
|
description: |
|
|
Publish the results of a sphinx build to
|
|
/afs/.openstack.org/project/starlingx.io/www/specs
|
|
|
|
Builds the docs using ``tox -e docs``.
|
|
# Set final to avoid override of afs_subpath variable.
|
|
final: true
|
|
allowed-projects:
|
|
- starlingx/specs
|
|
vars:
|
|
afs_subpath: "/specs"
|