2.2 KiB
{!create-stream.md!}
{!create-a-bot.md!}
Install the plugin
Install the "Zulip" plugin by going to Manage Jenkins > Manage Plugins > Available, typing in Zulip, and clicking Install without restart.
Configure the plugin
Once the plugin is installed, configure it by going to Manage Jenkins > Configure System. Scroll to the section labeled Zulip Notification Settings, and specify your Zulip server address, bot's email address and API key. Optionally, you may configure a default stream or topic. You can also enable smart notifications (i.e. only receive notifications when a build fails or recovers from a failed state).
(If you don't see this option, you may first need to restart Jenkins.)
Configure a post-build action for your project
Once you've done that, it's time to configure one of your freestyle projects to use the Zulip notification plugin. On your Jenkins project page, click Configure on the left sidebar. Scroll to the bottom until you find the section labeled Post-build Actions. Click the dropdown and select Zulip Notification. It should look as shown below. If you'd rather not use the defaults from the global configuration, you can set a custom stream and topic. If you don't specify a custom topic, the project name will be used as the topic instead. Then click Save.
When your builds fail or succeed, you'll see a message as shown below.
{!congrats.md!}
Advanced use cases
Besides the Zulip Notification post-build action, this plugin also supports the Zulip Send action. To learn more, see the plugin's README.
Troubleshooting
-
Did you set up a post-build action for your project?
-
Does the stream you picked (e.g.
jenkins) already exist? If not, create the stream and make sure you're subscribed to it. -
Are your API key and email address correct? Test them using our curl API.
-
Configure a Jenkins log recorder for jenkins.plugins.zulip and check why your messages fail to send.