summaryrefslogtreecommitdiff
path: root/doc/source/reference/pipeline_def.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/reference/pipeline_def.rst')
-rw-r--r--doc/source/reference/pipeline_def.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/source/reference/pipeline_def.rst b/doc/source/reference/pipeline_def.rst
index e2c2d9587..da13570f7 100644
--- a/doc/source/reference/pipeline_def.rst
+++ b/doc/source/reference/pipeline_def.rst
@@ -219,6 +219,13 @@ success, the pipeline reports back to Gerrit with ``Verified`` vote of
The introductory text in reports when an item is dequeued
without running any jobs. Empty by default.
+ .. attr:: dequeue-message
+ :default: Build canceled.
+
+ The introductory text in reports when an item is dequeued.
+ The dequeue message only applies if the item was dequeued without
+ a result.
+
.. attr:: footer-message
Supplies additional information after test results. Useful for
@@ -354,6 +361,12 @@ success, the pipeline reports back to Gerrit with ``Verified`` vote of
These reporters describe what Zuul should do when a pipeline is
disabled. See ``disable-after-consecutive-failures``.
+ .. attr:: dequeue
+
+ These reporters describe what Zuul should do if an item is
+ dequeued. The dequeue reporters will only apply, if the item
+ was dequeued without a result.
+
The following options can be used to alter Zuul's behavior to
mitigate situations in which jobs are failing frequently (perhaps
due to a problem with an external dependency, or unusually high