prepare-workspace: Add Role Variable in README.rst

Change-Id: I9bd85cbbf334a8d8c57b4adabf633e7046c273fd
This commit is contained in:
Guillaume Chauvel 2020-06-22 20:22:11 +02:00
parent ca56608a63
commit 21169062e6
1 changed files with 7 additions and 0 deletions

View File

@ -5,3 +5,10 @@ This role is intended to run before any other role in a Zuul job.
It starts the Zuul console streamer on every host in the inventory,
and then copies the prepared source repos to the working directory on
every host.
**Role Variables**
.. zuul:rolevar:: zuul_workspace_root
:default: .
The directory into which the source repositories are copied.