1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
.. _configuration:
Configuring supybot-github
==========================
.. TODO: Update 19->20 when we have enough configuration variables
Supybot-github contains more than nineteen configuration variables available
for you to play with, switchable globally, per channel, or per repository.
Changing the configuration
--------------------------
# TODO
Available configuration values
------------------------------
``channel``
The one IRC channel where notification messages should be sent by default
(can be changed in the hook URL, unless the `disallowChannelOverride` option
is set to True)
:Default value: ``#commits``
:Type: String
:Scope: `Global`
``port``
The port which will be used by the HTTP server to receive event information
from Github and other services
:Default value: `8093`
:Type: Integer
:Scope: `Global`
``shortURL``
Whether to use https://git.io/ to make URLs to github pages shorter
:Default value: `True`
:Type: Boolean
``hidePush``
Whether to hide the `User pushed .. commits into ...` message shown when a
push is received
.. TODO: Add an image
Force-pushes will still be shown regardless of this settings, if
``alwaysShowForcedPushes`` is set to True.
:Default value: `False`
:Type: Boolean
``theme``
The name of the theme that will be used to style IRC messages.
.. TODO: Add an image
Only two themes are currently available, ``default`` and ``compact``, which
is based on the default theme, with less verbose and more organised commit
notifications.
You can create your own themes, using the provided ``CompactTheme.py`` and
``DefaultTheme.py`` classes as examples. Themes are expected to be stored in
the ``local/theme/`` directory.
:Default value: `default`
:Type: String
``showMergedCommits``
Whether to show all the old merged commits when a branch is merged into
another branch
:Default value: `False`
:Type: Boolean
``showSuccessfulBuildMessages``
Whether to show build messages for non-failing builds on CI services, such
as Travis and AppVeyor. Setting to ``never`` will not show any message when
a build is successful, setting to ``always`` will show all success messages,
and setting this to ``change`` will only notify about successful builds, when
the previous build was broken (i.e. whenever the build is fixed).
:Default value: `change`
:Possible values: ``never``, ``change``, ``always``
:Type: Enum
``brackets``
A set of characters to use instead of parentheses to enclose URLs. This may
be useful if your IRC client considers the default parentheses part of the
URL, resulting in wrong paths and 404 errors.
.. TODO: Add an image
The ``brackets`` option is a string whose left half is the left bracket that
will be placed before the URL, and whose right half is the right URL bracket.
The middle character, if there is one, is ignored. This convention has the
limitation that the left and right parts of the URL must have the same length.
To bypass that, you can use the capital letter `M` to separate the string into
left and right:
============= =================================
Examples
------------------------------------------------
``brackets`` URL
============= =================================
*space* ``https://git.io/v2tq4``
``()`` ``(https://git.io/v2tq4)``
``[]`` ``[https://git.io/v2tq4]``
``[ ]`` ``[https://git.io/v2tq4]``
``[M]`` ``[https://git.io/v2tq4]``
``--> <--`` ``-->https://git.io/v2tq4<--``
``--> <--`` ``--> https://git.io/v2tq4 <--``
``-> M`` ``-> https://git.io/v2tq4``
============= =================================
``showMilestone``
Shows the name of the issue's milestone, when a notification is shown for
any issue update (if the milestone is specified).
.. TODO: Add an image
Milestone updates will still be shown if this is set to False.
:Default value: `True`
:Type: Boolean
``tagShowCommitMsg``
When a notification about a new tag is shown, display the message of the
commit the tag is pointing to.
:Default value: `True`
:Type: Boolean
``hideURL``
Whether to hide URLs for all actions.
Useful for private repositories
:Default value: `False`
:Type: Boolean
``preventIssueNameSpam``
If true, when many messages about the same Github issue are sent at the same
time (e.g. when multiple labels are added), the issue name and URL will only
be sent once, to reduce clutter.
:Default value: `True`
:Type: Boolean
``showIssueEdits``
Whether to send a message when an issue is edited.
:Default value: `True`
:Type: Boolean
``showPendingStatuses``
Whether to show a message for a "pending" status update by Github (e.g. when
a Travis build starts)
:Default value: `False`
:Type: Boolean
``alwaysShowForcedPushes``
Whether to always show force-pushes, regardless of the value of the `hidePush`
option.
:Default value: `True`
:Type: Boolean
``disallowChannelOverride``
Whether to force all commits to end up in the channel specified by the
`channel` configuration option, ignoring the channel specified in the HTTP
hook URL
:Default value: `False`
:Type: Boolean
:Scope: `Global`
``disallowConfigOverride``
Whether to ignore any configuration options provided in the HTTP hook URL
If the ``disallowChannelOverride`` option is set to True, URLs will still be
able to specify the notification's IRC channel, regardless of this setting.
:Default value: ``True``
:Type: Boolean
:Scope: `Global`
``allowArbitraryMessages``
Whether to allow raw messages and colours to be sent to channels using HTTP
(this does not bypass other security options)
:Default value: ``False``
:Type: Boolean
:Scope: `Channel`
|
