zuul
/
zuul
Code Issues Proposed changes

docs: add cleanup-run documentation 

Change-Id: Iee05d1d108fb8c1280f0bb95a365428ff8c99650
This commit is contained in:
Tristan Cacqueray 2019-05-30 07:25:33 +00:00
parent ad0af09111
commit df2a79baa2
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/user/config.rst
View File

@ -884,6 +884,16 @@ Here is an example of two job definitions:
playbooks are run before the parent's. See :ref:`job` for more
information.
.. attr:: cleanup-run
The name of a playbook or list of playbooks to run after a job
execution. The full path to the playbook in the repo
where the job is defined is expected.
The cleanup phase is performed unconditionally of the job's result,
even when the job is canceled. Cleanup results are not taken into
account.
.. attr:: run
The name of a playbook or list of playbooks for this job. If it

5
releasenotes/notes/job-cleanup-run-e651594d0fd73608.yaml Normal file
View File

@ -0,0 +1,5 @@
---
features:
- |
The :attr:`job.cleanup-run` attribute has been added to enable
a new cleanup phase to be performed after a job execution.