diff options
| author | Zuul <zuul@review.opendev.org> | 2020-12-12 08:58:03 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2020-12-12 08:58:03 +0000 |
| commit | fbe0872fefdd90f093b5be7179a8567f05a35884 (patch) | |
| tree | de7e2d62a5fe36a3c43c2e32ca3e071d647b5ba3 | |
| parent | f42604a8d9e814f996ffa827cbbafe9b4002b5e0 (diff) | |
| parent | f4a51a440721a01361dd530ca6736ba10e447a2b (diff) | |
| download | zuul-fbe0872fefdd90f093b5be7179a8567f05a35884.tar.gz | |
Merge "Clarify when to use zuul_return to pause a job."
| -rw-r--r-- | doc/source/reference/jobs.rst | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/source/reference/jobs.rst b/doc/source/reference/jobs.rst index 8aa1afa5a..71f164609 100644 --- a/doc/source/reference/jobs.rst +++ b/doc/source/reference/jobs.rst @@ -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 |