1.5 KiB
1.5 KiB
Installation
To install Gerritbot run :
sudo python setup.py install
Configuration File
Gerritbot has two configuration files. The first configures the IRC server and Gerrit server details and is the config file whose path you pass to gerritbot when starting the bot. It should look like:
[ircbot]
nick=NICKNAME
pass=PASSWORD
server=irc.freenode.net
port=6667
force_ssl=True or False (Defaults to False)
server_password=SERVERPASS
channel_config=/path/to/yaml/config (See below)
[gerrit]
user=gerrit2
key=/path/to/id_rsa
host=review.example.com
port=29418
The second, referenced by [ircbot]channel_config
in the
above, configures the IRC channels and the events and projects that each
channel is interested in. This config file is written in yaml and should
look like:
example-channel1:
events:
- patchset-created
- change-merged
- ^x-(crvw|vrif)-(plus|minus)-2$
projects:
- example/project1
- example/project2
branches:
- master
- development
example-channel2:
events:
- change-merged
projects:
- ^example/project[34]$
- ^example/interesting-
branches:
- master
- ^stable/(newton|ocata|pike)$
Denote regular expressions using the prefix ^
.
Running
To run Gerritbot $PATH/gerritbot /path/to/config. $PATH is usually something like /usr/local/bin and /path/to/config should be whatever path you have hidden the config at.