Skip to content

Commit

Permalink
Add reports section to the Zuul user guide
Browse files Browse the repository at this point in the history
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 <matej.feder@dnation.cloud>
  • Loading branch information
matofeder committed Nov 30, 2023
1 parent c96a0be commit 03f6a6b
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions dev-docs/operations/operations/zuul-ci-cd-quickstart-user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 03f6a6b

Please sign in to comment.