From 03f6a6b934087926c14cae1fab4d8a129e769d3b Mon Sep 17 00:00:00 2001 From: Matej Feder Date: Thu, 30 Nov 2023 13:47:05 +0100 Subject: [PATCH] Add reports section to the Zuul user guide This commit notifies SCS Zuul users about the activation of reporting to the Matrix chat room `SCS | Zuul Reports` for periodic pipelines (periodic-hourly, periodic-daily, compliance_check). Additionally, it includes an example demonstrating how to configure MQTT reporting in the pipeline. Signed-off-by: Matej Feder --- .../zuul-ci-cd-quickstart-user-guide.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/dev-docs/operations/operations/zuul-ci-cd-quickstart-user-guide.md b/dev-docs/operations/operations/zuul-ci-cd-quickstart-user-guide.md index 6d8f3c96d2..f764f01733 100644 --- a/dev-docs/operations/operations/zuul-ci-cd-quickstart-user-guide.md +++ b/dev-docs/operations/operations/zuul-ci-cd-quickstart-user-guide.md @@ -168,6 +168,27 @@ Pipelines available in SCS Zuul: If you want to know more about pipelines: [See official documentation](https://zuul-ci.org/docs/zuul/latest/config/pipeline.html) +### Reports + +The SCS Zuul instance can transmit build reports through an MQTT connection +to the dedicated Matrix chat room `SCS | Zuul Reports`. Currently, this MQTT reporting +feature is activated for periodic pipelines (periodic-hourly, periodic-daily, +compliance_check), and reports are dispatched solely in the event of +failures occurring in builds triggered by the mentioned pipelines. + +See an example pipeline that reports failed result to the `SCS | Zuul Reports` Matrix room: + +```yaml +- pipeline: + name: pipeline-that-reports-to-matrix + description: | + In the event of a failure, this pipeline transmits reports to + the SCS | Zuul Reports Matrix chat room. + failure: + mqtt: + topic: "zuul/{pipeline}/{project}/{branch}/{change}" +``` + ### Jobs All jobs that your Zuul instances knows of can be used for your own purposes.