zuul/zuul-jobs
Code Issues Proposed changes

Expand documentation of test-setup role

Browse Source 
It honors this variable, but does not document it.

Change-Id: I67760c27f0843f8d5a41682878be3cce53c08ba4
This commit is contained in:
James E. Blair 2019-06-24 15:53:52 -07:00 committed by Andreas Jaeger
parent 23f9f9ae6c
commit 023cee1106
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
roles/test-setup/README.rst
View File

@ -1,9 +1,9 @@
Perform project test setup tasks.
This role assumes that Zuul has checked out a change for a project at
``src/{{ zuul.project.canonical_name }}`` and looks for a file named
``tools/test-setup.sh``. If that file exists and is executable, it will
be run.
``{{ zuul_work_dir }}`` and looks for a file named
``tools/test-setup.sh``. If that file exists and is executable, it
will be run.
This allows projects to specify test-setup steps (such as creating or
initializing a database) in a form that can be easily run by both an
@ -20,3 +20,8 @@ automated testing system and developers.
String of optional command line options passed to
the test-setup script.
.. zuul:rolevar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
The directory in which to look for the setup script.