Mercurial > bitten > bitten-test

annotate doc/notify.txt @ 754:545be0c8f405

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Adding the ability to modify the default ''onerror'' property in the ''<build>'' element. If not specified, the behavior is unchanged; by default any step failure will result in the build failing and stopping. Added a new ''continue'' onerror specification-- it's similar to ''ignore'' except the results of ''continue'' steps are counted in the overall build status (in ''ignore'' they're ignored.) You'll need to upgrade both your master and slaves if you wish to use the ''<build>'' element override or the new ''continue'' value. Will update http://bitten.edgewall.org/wiki/Documentation/recipes.html . Thanks to jerith for comments. Closes #409. Refs #210.
author wbell
date Sat, 24 Apr 2010 13:37:26 +0000
parents 01cc0c8e49fb
children
rev   line source
672
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
1 .. -*- mode: rst; encoding: utf-8 -*-
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
2
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
3 ==================
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
4 Build Notification
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
5 ==================
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
6
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
7 Introduction
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
8 ============
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
9
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
10 Bitten includes a mechanism to send out notification mails whenever a build
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
11 has failed (or succeeded, if required).
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
12
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
13 The notification mails contain the revision number of the build, the author
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
14 name and the build log.
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
15
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
16 Notification Example:
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
17
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
18 .. code-block:: text
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
19
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
20 Failed build of MyProject [32]
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
21 ---------------------------------------------------------------------
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
22
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
23 Changeset: 32 - <http://trac.mydomain.com/changeset/32>
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
24 Committed by: author
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
25
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
26 Build Configuration: main
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
27 Build Slave: client
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
28 Build Number: 30 - <http://trac.mydomain.com/build/main/30>
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
29
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
30 Failed Steps:
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
31 Failure Log:
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
32
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
33
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
34 Configuration
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
35 =============
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
36
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
37 The mechanism employs the trac notification system and uses most of its
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
38 options of the ``[notification]`` section of ``trac.ini``, specifically:
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
39
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
40
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
41 +-------------------------+--------------------------------------------------+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
42 | Option | Description |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
43 +=========================+==================================================+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
44 | ``smtp_enabled`` | activates mail notifications |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
45 +-------------------------+--------------------------------------------------+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
46 | ``smtp_default_domain`` | the domain to be appended to not fully qualified |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
47 | | usernames |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
48 +-------------------------+--------------------------------------------------+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
49 | ``smtp_server`` | the smtp server to use |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
50 +-------------------------+--------------------------------------------------+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
51 | ``smtp_user`` | smtp server username |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
52 +-------------------------+--------------------------------------------------+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
53 | ``smtp_password`` | smtp server password |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
54 +-------------------------+--------------------------------------------------+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
55
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
56 For an indepth description of the trac notification system and its options
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
57 please refer to the `Trac documentation`_.
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
58
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
59 .. _`trac documentation`: http://trac.edgewall.org/wiki/TracNotification
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
60
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
61
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
62 To further adjust the notification behaviour you can use the following
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
63 options:
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
64
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
65 +--------------------------------+-------------------------------------------+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
66 | Option | Description |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
67 +================================+===========================================+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
68 | ``notify_on_failed_build`` | notifies on failed builds (defaults to |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
69 | | ``True``) |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
70 +--------------------------------+-------------------------------------------+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
71 | ``notify_on_successful_build`` | notifies on successful builds (defaults |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
72 | | to ``False``) |
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
73 +--------------------------------+-------------------------------------------+
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
74
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
75 Configuration Example:
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
76
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
77 .. code-block:: ini
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
78
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
79 [notification]
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
80 smtp_enabled = true
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
81 smtp_default_domain = mydomain.com
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
82 smtp_server = smtp.mydomain.com
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
83 smtp_user = admin@mydomain.com
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
84 smtp_password = 12345
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
85 notify_on_failed_build = true
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
86 notify_on_successful_build = true
01cc0c8e49fb 0.6dev: Adding documentation for Notification. Closes #440.
osimons
parents:
diff changeset
87
Copyright (C) 2012-2017 Edgewall Software