summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Cacqueray <tdecacqu@redhat.com>2017-12-13 08:51:58 +0000
committerTristan Cacqueray <tdecacqu@redhat.com>2017-12-13 08:51:58 +0000
commitff47ff04c2e1d622710a6ff4c294ceab10a18513 (patch)
tree26c7fe61c6fd120ade39f437db99ce3c3c9989d7
parent83f504c966c0b83a2ae1e174975d7ba5bd7a705e (diff)
downloadzuul-ff47ff04c2e1d622710a6ff4c294ceab10a18513.tar.gz
doc: refine zuul_return instruction
The zuul_return task needs to be executed on the executor node, otherwise it fails with KeyError: 'ZUUL_JOBDIR' Change-Id: Ib02648f40b1602c85b8c70ee0965f0fde2d227fe
-rw-r--r--doc/source/user/jobs.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/source/user/jobs.rst b/doc/source/user/jobs.rst
index 278c4f453..4b6255b20 100644
--- a/doc/source/user/jobs.rst
+++ b/doc/source/user/jobs.rst
@@ -540,7 +540,8 @@ Return Values
A job may return some values to Zuul to affect its behavior and for
use by other jobs.. To return a value, use the ``zuul_return``
-Ansible module in a job playbook. For example:
+Ansible module in a job playbook running on the executor 'localhost' node.
+For example:
.. code-block:: yaml