diff options
| author | James E. Blair <jim@acmegating.com> | 2022-09-07 11:52:03 -0700 |
|---|---|---|
| committer | James E. Blair <jim@acmegating.com> | 2022-09-13 18:05:42 -0700 |
| commit | 9a3b028fa21013812585fcf1291bad130563c64c (patch) | |
| tree | 1453b9a832f6928b9ec51b5f71242548bce47983 /doc | |
| parent | 0b4c6b011701f8723cb722a739d2ce24d6ad4376 (diff) | |
| download | zuul-9a3b028fa21013812585fcf1291bad130563c64c.tar.gz | |
Add option to include returned data in MQTT reporter
This adds an option to include result data from a job in the MQTT
reporter. It is off by default since it may be quite large for
some jobs.
Change-Id: I802adee834b60256abd054eda2db834f8db82650
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/drivers/mqtt.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/source/drivers/mqtt.rst b/doc/source/drivers/mqtt.rst index 10cd4c8a2..81969ae8b 100644 --- a/doc/source/drivers/mqtt.rst +++ b/doc/source/drivers/mqtt.rst @@ -316,3 +316,9 @@ reporter. Each pipeline must provide a topic name. For example: The quality of service level to use, it can be 0, 1 or 2. Read more in this `guide <https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels>`_ + + .. attr:: include-returned-data + :default: false + + If set to ``true``, Zuul will include any data returned from the + job via :ref:`return_values`. |