Browse Source

Merge "Expand documentation of test-setup role"

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

Loading…
Cancel
Save