Browse Source

Merge "Expand documentation of test-setup role"

changes/90/667590/3
Zuul 5 months ago
parent
commit
4ba149c48e
1 changed files with 8 additions and 3 deletions
  1. +8
    -3
      roles/test-setup/README.rst

+ 8
- 3
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.


Loading…
Cancel
Save