zuul-jobs/roles/generate-zuul-manifest/README.rst
James E. Blair 2aa0dbcf29 Add index_links option to zuul manifest
This allows a deployer to indicate that they prefer the Zuul
dashboard to link to "dir/index.html" rather than just "/dir" when
displaying directory entries in the log browser.  This helps with
log storage systems which do not automatically serve index.html
files at directory urls.

Change-Id: I0444798c689667e51d8761a20b661f8a9b90323d
2020-02-05 07:19:20 -08:00

35 lines
959 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.
.. zuul:rolevar:: generate_zuul_manifest_index_links
:default: False
If True, the Zuul dashboard will link to "index.html" for directory
entries; if False, it will link to the bare directory.