trompet is an IRC bot for transmitting commit messages to IRC channels. It comes with an XML-RPC interface for receiving messages as well as a Bitbucket POST Service receiver.
trompet requires Python 2.5 or newer (not including any of the Python 3 releases) as well as Twisted (only tested with Twisted 12).
trompet uses JSON for its configuration file. It's a single JSON object with the following keys: networks, web and projects.
See config.sample for a sample configuration.
The configuration can be reloaded by sending the signal SIGHUP to trumpet.
The IRC networks to which trompet should connect. Every network
requires at least the keys servers and nick. The keys
password and nickserv-password are optional. trompet uses a randomly
chosen item out of servers for connecting.
Example:
"networks": {
"example": {
"servers": [["irc.example.org", 6667]],
"nick": "trompet",
"password": "The super secret server password",
"nickserv-password": "secret"
}
}
Note
You might have noticed that no channels are configured for the networks. That is because every project in the projects section has a list of channels to which trompet should announce commits.
An object with two keys, port and password:
- password is the password that protects the projects listing page
- port specifies on which port trompet listens to service requests
Example:
"web": {
"password": "secret",
"port": 8080
}
Each project requires at least the following keys: channels and token. token should be a random, not easily guessable string. It must consist only of a-z, A-Z, 0-9, _ or -.
Example:
"projects": {
"example project": {
"channels": {"example": ["#example"]},
"token": "my secret token",
"bitbucket": {
"message": "$author committed rev $revision to $project/$branch: $shortmessage - $url"
},
"xmlrpc": true
}
}
Just add something like the following to your project configuration:
"bitbucket": {
"message": "$author committed rev $revision to $project/$branch: $shortmessage - $url"
}
You can then point your POST Service URL at your bitbucket repository
to http://host:port/<project token>/bitbucket.
The following variables can be used in message:
- author: The commit's author.
- branch: The branch into which the commit was pushed.
- revision: Commit's (short) hash.
- message: The complete commit message.
- shortmessage: Only the first line of the commit message.
- url: URL to the changeset on bitbucket.
If you want to limit the number of commit messages per push, you can
set the key max commit messages per push to a numerical value. The
default value is null / None / unlimited.
Like bitbucket, but replace bitbucket with github.
Similar bitbucket and GitHub., but use travisci instead. The following
additional variables can be used in message:
- reporturl: URL to the build results at Travis CI.
- statusmessage: Travis CI status message.
Note that Travis CI sends an Authorization header and the listener checks if
the header is valid. This check requires the Travis CI token to be present in
the token setting in the travisci configuration block:
"travisci": {
"message": "Travis CI build for $project/$branch, rev $revision: $statusmessage - $reporturl",
"token": "Travis CI token"
}
Add the following snippet to you project configuration:
"xmlrpc": true
The XML-RPC interface can be reached under
http://host:port/<project token>/xmlrpc. For sending messages,
one can use the method notify(message).
Nope, you can point your browser to http://host:port/projects and
you'll get a nice list of projects and the corresponding URLs. The
site requires a username and password. The username is admin, the
password is the one you set in the configuration (section web, key
password).
trompet is started using twistd. Just run
twistd trompet <path to config file>
See twistd(1) for additional options.
Bugs are reported best at trompet's project page on github.
trompet is distributed under a 3-clause BSD license. See LICENSE for details.
trompet is a buffer.io project.