zuul
/
zuul
Code Issues Proposed changes

Clarify when to use zuul_return to pause a job. 

Change-Id: I5e1966aeaa761dbbd92b6977fcfc7a717bdb08f3
This commit is contained in:
Albin Vass 2020-12-11 17:09:21 +01:00
parent c911e26fa6
commit f4a51a4407
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/reference/jobs.rst
View File

@ -920,12 +920,14 @@ the elements of `zuul.file_comments` from each invocation will be appended.
Pausing the job
~~~~~~~~~~~~~~~
A job can be paused after the run phase. In this case the dependent jobs can start
and the prior job stays paused until all dependent jobs are finished. This for
example can be useful to start a docker registry in a job that will be
used by the dependent job. To indicate that the job should be paused use
*zuul_return* to set the **zuul.pause** value. You still can at the same time
supply any arbitrary data to the dependent jobs. For example:
A job can be paused after the run phase by notifing zuul during the run phase.
In this case the dependent jobs can start and the prior job stays paused until
all dependent jobs are finished. This for example can be useful to start
a docker registry in a job that will be used by the dependent job.
To indicate that the job should be paused use *zuul_return* to
set the **zuul.pause** value.
You still can at the same time supply any arbitrary data to the dependent jobs.
For example:
.. code-block:: yaml