Jenkins

Overview

This Zeleo Application allows you to react to build events on Zeleo. What can you do with this? Well- Zeleo is intentionally a very open platform, so almost anything you want! For example, you could assign tasks to developers on a buid failure to fix tests, trigger unit/integration tests depending on the day of the week to spread out testing, let you Slack channel know every detail of your build, etc. You could even use us to trigger deployments on other systems (like AWS or Azure).

Jenkins Setup

Getting Jenkins ready to interact with Zeleo is as simple as installing a plugin and adding it to your build job. Follow the steps below to get this working.

• Add the Jenkins Plugin to your Jenkins installation from the Jenkins Plugin Site.
• Configure your build job (or create a new one) and select Zeleo Build Event from your Post Build Events drop down.
• Once added, you will be able to select whether to trigger the event at the start of the build, when the build completes, or both.

• Then you need to add the email address of the Zeleo user you want to listen for these build events. Remember, Zeleo needs all events to be tied to a user, even if it’s just system to system. This allows Zeleo to engage its social graph of your team if you so desire.
• That’s it! Zeleo will now receive events from your build system from your Jenkins installation. There are some steps on the Zeleo side to get things working, but we’ll do that in the next section.

This does not have to be the email you used for your Zeleo user; you will just need to specify this email address in at least one user’s configuration. We did this to allow your team to have more than one build listener if you prefer just by adding this email address to their configuration. We’ll get into this more later. And yeah- it doesn’t really have to be an email address, you just want a unique string that matches. Email is an easy way to have a unique identifier.

Zeleo Configuration

Once you have the plugin installed and added to your build job, you need to have Zeleo react to them. There are three simple steps you will need to do to get Zeleo ready.

Add Jenkins Application to your Team

• The first action you will need to take is to open the Team Management dialog as a team administrator.
• Click on the Applications tab in this dialog, and find the Jenkins Zeleo Application at the bottom of the dialog.
• Click the + sign to the right of the Jenkins application. The application will move from Available Applications to Installed Applications.
• All set! Jenkins is installed to your team.

Set Up Listener User(s)

Every Zeleo event must have a user that is the target. In this case you will specify this by adding the email address from your Jenkins Zeleo Plugin configuration to one or more users.

• Log in as the user you want to listen to the buid events.
• Open the Edit Profile dialog.
• Select the Applications tab and find Jenkins.

• In the Jenkins Email Address enter the email string you added in Jenkins Setup step 4. This really just needs to be the same unique string, case sensitive, but we recommend an email address. You could also generate a UUID if you prefer.

Create Rules

Now you can do the fun part- configure Zeleo to react to your Jenkins Build Jobs!

Rules in Zeleo are simple condition statements. There are all sorts of thing you can do with this; Zeleo is a platform to allow you to do whatever you want with few limitations. Please go here for more information on how to use the platform.

• Open the left side panel (you must have creator rights- talk to your team administrator if you do not have them) and select Rules & Conditions.
• Click the + button at the bottom left of the screen to create a new rule.
• Name and describe your new rule for future bookkeeping.
• Select Jenkins from the initial dropdown.

• Choose the Build Event Jenkins Event.

• Set the target of your event. Remember when we added the email address to a user above? Set the Listener variable to Person and the target of the build event will be referenced as Person in the Consequence tab. If you are unsure, just make it look like the screenshot below, as this is the most common configuration.

  This can be a bit confusing, but it is also quite powerful. It allows you to set up a relationship graph among your team and refernce team members by how they relate. For instance, if one or more people were Direct Reports of the Person, you can set a consequence to send a Slack Direct Message to all these people. You can read more here, or just contact us at support@zeleoinc.com and we’ll help you out!

• Set any other conditions that you want to be True in order for the consequence to trigger.

• Click on the Consequence tab and select how you want Zeleo to react! There are all sorts of possibilities here, from sending an email, text message, assigning a Zeleo task, Slack posts (both direct and to a channel), etc. Let us know if what you need isn’t listed- we’re happy to build out the possibilities of Zeleo!

Conclusion

Zeleo is intentionally powerful at the expense of simplicity. A bold move in this day and age, but we would love to help you to make sure you are getting the most of the Zeleo setup. Please don’t hesitate to reach out- no charge; we’ll make sure you are happy with the product!