| Joshua Hesketh | 1879cf7 | 2013-08-19 14:13:15 +1000 | [diff] [blame^] | 1 | :title: Reporters |
| 2 | |
| 3 | Reporters |
| 4 | ========= |
| 5 | |
| 6 | Zuul can communicate results and progress back to configurable |
| 7 | protocols. For example, after succeeding in a build a pipeline can be |
| 8 | configured to post a positive review back to gerrit. |
| 9 | |
| 10 | There are three stages when a report can be handled. That is on: |
| 11 | Start, Success or Failure. Each stage can have multiple reports. |
| 12 | For example, you can set verified on gerrit and send an email. |
| 13 | |
| 14 | Gerrit |
| 15 | ------ |
| 16 | |
| 17 | Zuul works with standard versions of Gerrit by invoking the |
| 18 | ``gerrit`` command over an SSH connection. It reports back to |
| 19 | Gerrit using SSH. |
| 20 | |
| 21 | The dictionary passed to the gerrit reporter is used for ``gerrit |
| 22 | review`` arguments, with the boolean value of ``true`` simply |
| 23 | indicating that the argument should be present without following it |
| 24 | with a value. For example, ``verified: 1`` becomes ``gerrit review |
| 25 | --verified 1`` and ``submit: true`` becomes ``gerrit review |
| 26 | --submit``. |
| 27 | |
| 28 | Gerrit Configuration |
| 29 | ~~~~~~~~~~~~~~~~~~~~ |
| 30 | |
| 31 | The configuration for posting back to gerrit is shared with the gerrit |
| 32 | trigger in zuul.conf. Please consult the gerrit trigger documentation. |