{% extends "zephyr/portico.html" %} {# API information page #} {% block customhead %} {{ block.super }} {% endblock %} {% block portico_content %}

Integrations

The English poet John Donne once wrote that "no man is an island", and we feel the same about software. No system exists in complete isolation, so we've made it easy for Humbug to connect to the services you already use.

With the integrations below, your team can stay up-to-date on code changes, issue tickets, build system results, and much more. So ask not for whom the notification tolls—it tolls for thee! (Or for a team member of yours, I guess.)

Getting started

Many of these integrations are available in our API download. They also require a registered Humbug user to send as. You can use your existing account, or register a new one for them. (If new email addresses are hard to come by, you can use something like wdaher+github@example.com.)

Services with integrations

GitHub

First, go to your repository page and click "Settings":

From there, select "Service Hooks":

Select "Humbug" from the list, fill in the API key and email address for your bot, check the "active" checkbox, and pick "Update settings":

Congratulations! You're done!
When people push to your repository, you'll see a commit message like the following, to the stream commits with a subject that matches the repository name (in this case "humbug-test"):

^ Back to top

{#--------------------------------------------------------------------#}

Jenkins (or Hudson)

Download the Humbug Jenkins plugin. To install the plugin, select "Manage Jenkins", "Manage Plugins", and then "Advanced". Under the section labeled "Upload Plugin", select humbug-jenkins-0.1.hpi from your computer, and upload it:

After uploading the plugin, restart Jenkins for the installation to take effect. Some versions of Jenkins have a link to restart on the "Install" tab of the "Manage Plugins" page. If your version does not, and you have access to a shell on the computer running Jenkins, service jenkins restart will restart it on a Linux system.

Once Jenkins has restarted, it's time to configure our plugin. Go to "Manage Jenkins" and then to "Configure System".

Scroll to the section labeled "Humbug Notification Settings", and specify your bot's email address, API key, and where you'd like your notification messages to go (we recommend, e.g. stream jenkins).

The other two options you might want to adjust are "Smart Notification" (do you want a message after every single build, or only after a status change?), and "Jenkins URL" -- the URL to your instance of Jenkins, so that we can link you to specific build reports.

(If you don't see the Humbug option in the list, confirm that the plugin was successfully installed by going to "Manage Jenkins", "Manage Plugins", "Installed", and confirming that "Jenkins Humbug Plugin" appears in the list. If it does not, the plugin was not successfully installed. Make sure that you have the Maven plugin installed and try again, or email support@humbughq.com for help.)

Once you've done that, it's time to configure one of your projects to use the Humbug notification plugin. From your project page, click "Configure" on the left sidebar:

Then, scroll to the bottom until you find the section labeled "Post-build Actions". Click the dropdown and select "Humbug Notification". It should look as below. Then click "Save".

Congratulations! You're done!
When your builds fail or succeed, you'll see a commit message like the following with a subject that matches the project name (in this case "Humbug Test"):

^ Back to top

{#--------------------------------------------------------------------#}

Trac

First, download and install our Python bindings and example scripts.

Next, open integrations/humbug_trac.py in your favorite editor, and change the following lines to specify your bot's email address, API key, and where you'd like your notification messages to go (by default, stream trac):

HUMBUG_USER = "trac-notifications@example.com"
HUMBUG_API_KEY = "0123456789abcdef0123456789abcdef"
STREAM_FOR_NOTIFICATIONS = "trac"
TRAC_BASE_TICKET_URL = "https://trac.example.com/ticket"

Copy the file to your Trac server, placing it in the Trac plugins/ subdirectory. Once you've done that, edit conf/trac.ini to add humbug_trac to the [components] section, as follows:

[components]
humbug_trac = enabled

You may then need to restart Trac (or Apache) so that Trac will load our plugin.

Congratulations! You're done!
When people open new tickets (or edit existing tickets), you'll see a message like the following, to the stream trac (or whatever you configured above) with a subject that matches the ticket name:

^ Back to top

{% endblock %}