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.