blob: 7c0214dbe57489b243cf850f8af32beb3262ca2d [file] [log] [blame]
Joshua Hesketh1879cf72013-08-19 14:13:15 +10001:title: Reporters
2
3Reporters
4=========
5
6Zuul can communicate results and progress back to configurable
7protocols. For example, after succeeding in a build a pipeline can be
Michael Prokop526926a2013-10-24 16:16:57 +02008configured to post a positive review back to Gerrit.
Joshua Hesketh1879cf72013-08-19 14:13:15 +10009
10There are three stages when a report can be handled. That is on:
11Start, Success or Failure. Each stage can have multiple reports.
Michael Prokop526926a2013-10-24 16:16:57 +020012For example, you can set verified on Gerrit and send an email.
Joshua Hesketh1879cf72013-08-19 14:13:15 +100013
14Gerrit
15------
16
17Zuul works with standard versions of Gerrit by invoking the
18``gerrit`` command over an SSH connection. It reports back to
19Gerrit using SSH.
20
Michael Prokop526926a2013-10-24 16:16:57 +020021The dictionary passed to the Gerrit reporter is used for ``gerrit
Joshua Hesketh1879cf72013-08-19 14:13:15 +100022review`` arguments, with the boolean value of ``true`` simply
23indicating that the argument should be present without following it
24with a value. For example, ``verified: 1`` becomes ``gerrit review
25--verified 1`` and ``submit: true`` becomes ``gerrit review
26--submit``.
27
28Gerrit Configuration
29~~~~~~~~~~~~~~~~~~~~
30
Michael Prokop526926a2013-10-24 16:16:57 +020031The configuration for posting back to Gerrit is shared with the Gerrit
Joshua Hesketh5fea8672013-08-19 17:32:01 +100032trigger in zuul.conf as described in :ref:`zuulconf`.
33
34SMTP
35----
36
37A simple email reporter is also available.
38
39SMTP Configuration
40~~~~~~~~~~~~~~~~~~
41
Michael Prokop526926a2013-10-24 16:16:57 +020042zuul.conf contains the SMTP server and default to/from as describe
Joshua Hesketh5fea8672013-08-19 17:32:01 +100043in :ref:`zuulconf`.
44
James E. Blaire5910202013-12-27 09:50:31 -080045Each pipeline can overwrite the subject or the to or from address by
46providing alternatives as arguments to the reporter. For example, ::
Joshua Hesketh5fea8672013-08-19 17:32:01 +100047
48 pipelines:
49 - name: post-merge
50 manager: IndependentPipelineManager
51 trigger:
52 - event: change-merged
53 success:
54 smtp:
55 to: you@example.com
56 failure:
57 smtp:
58 to: you@example.com
59 from: alternative@example.com
James E. Blaire5910202013-12-27 09:50:31 -080060 subject: Change {change} failed