diff --git a/static/images/integrations/jenkins/002.png b/static/images/integrations/jenkins/002.png index ddabe5981e..ca8a0bd06b 100644 Binary files a/static/images/integrations/jenkins/002.png and b/static/images/integrations/jenkins/002.png differ diff --git a/static/images/integrations/jenkins/003.png b/static/images/integrations/jenkins/003.png index eb2267a759..4d8e55f4b7 100644 Binary files a/static/images/integrations/jenkins/003.png and b/static/images/integrations/jenkins/003.png differ diff --git a/static/images/integrations/jenkins/004.png b/static/images/integrations/jenkins/004.png index 72012ae953..f2cd84371b 100644 Binary files a/static/images/integrations/jenkins/004.png and b/static/images/integrations/jenkins/004.png differ diff --git a/templates/zerver/integrations/jenkins.md b/templates/zerver/integrations/jenkins.md index df64b17112..933f93f700 100644 --- a/templates/zerver/integrations/jenkins.md +++ b/templates/zerver/integrations/jenkins.md @@ -1,5 +1,7 @@ {!create-stream.md!} +{!create-a-bot.md!} + ### Install the plugin Install the "Zulip" plugin by going to @@ -15,9 +17,10 @@ restart**. (For historical reasons, the plugin might be named 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 -bot's email address, API key, the stream receiving the -notifications, and whether you'd like a notification on every -build, or only when the build fails (Smart Notification). +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.) @@ -27,32 +30,43 @@ Jenkins.) ### Configure a post-build action for your project Once you've done that, it's time to configure one of your -projects to use the Zulip notification plugin. From your -project page, click **Configure** on the left sidebar. Scroll to +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 below. Then click **Save**. +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**. ![](/static/images/integrations/jenkins/003.png) -When your builds fail or succeed, you'll see a commit message -with a topic that matches the project name (in this case -"SecretProject"). +When your builds fail or succeed, you'll see a message as shown below. {!congrats.md!} ![](/static/images/integrations/jenkins/004.png) +### 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](https://github.com/zulip/zulip-jenkins-plugin). + ### Troubleshooting 1. Did you set up a post-build action for your project? -2. Does the stream you picked (e.g. `jenkins`) already exist? - If not, add yourself to it and try again. +1. Does the stream you picked (e.g. `jenkins`) already exist? + If not, create the stream and make sure you're subscribed to it. -3. Are your access key and email address correct? Test them +1. Are your API key and email address correct? Test them using [our curl API](/api). -4. Still stuck? Email [zulip-devel@googlegroups.com][mail]. +1. Configure a Jenkins log recorder for **hudson.plugins.humbug** + and check why your messages fail to send. + +1. Still stuck? Email [zulip-devel@googlegroups.com][mail]. [mail]: mailto:zulip-devel@googlegroups.com?subject=Jenkins