GitHub
Overview
Github and Zeleo are a perfect fit; you can use Zeleo to monitor and react to any sort of change to your project and repository. You can either use Zeleo to send notifications when a forced pull request is forced, etc, assign tasks to your team when an issue is assigned or a comment is made on an issue assigned to them, or all the above.
We use this internally to streamline development process of the Zeleo platform!
Setup
GitHub
As of now, Zeleo leverages the GitHub Webhook functionality to react to events. More events are added constantly, so if you see something missing, please let us know so we can prioritize adding it to Zeleo. We also will implement the API for consequences to perform an action when an event occurs; this shud come in a matter of weeks.
First thing you will need to do in GitHub is log in and click the Settings
icon in your repository. Once there, do the following:
- Click on
Webhooks
in the menu on the left. - Select
Add Webhook
. - Add the following to the
Payload URL
field:
https://github.zeleo.io/zeleo-github-adapter/services/adapter/webhook
- Select
application/json
from theContent type
dropdown. - Select the
Send me everything
radio button. - Make sure the Webhook is
Active
and save.
Okay- now Zeleo is getting events. Now you need to enable the application for your team and have people put their usernames into their accounts.
- Open the
Manage Team
dialog. - Select the
Applications
tab and click the plus symbol next to theGitHub
application.
- Have all your users (yourself included) go to their
Profile
dialog and select theApplications
tab. - Enter your GitHub user name in the
Username
field.
That’s it! Now you’re ready to react to events from your repository.
To get started, open the side panel in Zeleo and select Rules & Conditions
and do the following:
- Click the plus symbol to create a new Rule.
- Select GitHub from the
Select a Condition
dropdown. - Select the event. Again, if the event you want to react to is not there, please email us at support@zeleoinc.com. We are adding more weekly.
- You want to make sure each event is tied to a person. This usually means setting the
assignee
asPerson
, though other fields might be talking about a person as well.
- Once a person is defined for the rule, you are free to fine tune the logic as needed. There are many fields you can define both in the rule and in the communitcation/task template triggered in the consequence.
Events
The following events are handled with more to come!
Consequences
No consequences are defined by this Zeleo Application yet, but there will be soon.