Clarify usage of the zuul_success variable

The docs tell us to use the zuul_success variable together with the
'boolean' filter. In fact the filter is named 'bool'. Fix that and add
an example.

Change-Id: Ibb4dc6b10f6f46ec6746bcf3230e6847cb9d0c93
This commit is contained in:
Tobias Henkel 2018-06-13 11:23:39 +02:00
parent f67bdd0f35
commit eae5606b99
No known key found for this signature in database
GPG Key ID: 03750DEC158E5FA2
1 changed files with 7 additions and 1 deletions

View File

@ -364,7 +364,13 @@ of item.
Post run playbook(s) will be passed this variable to indicate if the run Post run playbook(s) will be passed this variable to indicate if the run
phase of the job was successful or not. This variable is meant to be used phase of the job was successful or not. This variable is meant to be used
with the `boolean` filter. with the `bool` filter.
.. code-block:: yaml
tasks:
- shell: echo example
when: zuul_success | bool
Change Items Change Items