zuul-jobs/roles/fetch-sphinx-tarball/README.rst
James E. Blair 189c2471ec Add fetch-sphinx-tarball role
This is a new artifact-aware method of fetching sphinx tarballs,
meant to be used in docs promote jobs.

Change-Id: I9a01af9e36b959c4fa42f3c41b548c87bf2e1759
2019-03-21 14:04:11 -07:00

19 lines
517 B
ReStructuredText

Collect output from a sphinx build as a tarball
By default, this copies the output from the sphinx build on the worker
to the log root of the executor as a tarball, and then extracts the
archive into the log root for viewing.
**Role Variables**
.. zuul:rolevar:: sphinx_build_dir
:default: doc/build
Directory relative to zuul_work_dir where build output should be
found.
.. zuul:rolevar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
The location of the main working directory of the job.