zuul-jobs/roles/generate-zuul-manifest/README.rst
James E. Blair 02d9a29562 Fix typo in generate-zuul-manifest role
Change-Id: I763a7a6e95f08ba07b38ed6b1701fe16e2548471
2019-07-23 11:58:01 -07:00

29 lines
756 B
ReStructuredText

Generate a Zuul manifest file for log uploading
This generates a manifest file in preparation for uploading along
with logs. The Zuul web interface can fetch this file in order to
display logs from a build.
**Role Variables**
.. zuul:rolevar:: generate_zuul_manifest_root
:default: {{ zuul.executor.log_root }}
The root directory to index.
.. zuul:rolevar:: generate_zuul_manifest_filename
:default: zuul-manifest.json
The name of the manifest file.
.. zuul:rolevar:: generate_zuul_manifest_output
:default: {{ zuul.executor.log_root }}/{{ generate_zuul_manifest_filename }}
The path to the output manifest file.
.. zuul:rolevar:: generate_zuul_manifest_type
:default: zuul_manifest
The artifact type to return to Zuul.