jhaals / tutter

Plugin based Github robot

Tutter - Plugin based Github robot

Tutter is a robot that can trigger customizable actions based on Github [events]((https://developer.github.com/v3/activity/events/types/)(push, pull_request, release, issue, ..)

Installation

gem install tutter

Place configuration file in /etc/tutter.yaml, example can be found in the conf/ directory.

tutter.yaml settings

• name - username/project_name
• access_token - Github access token (can be generated here)
• github_site - github website
• github_api_endpoint - github api endpoint
• hook_secret - (Optional) validate hook data based on known secret(more).
• action - action you wish to use for the project
• action_settings - whatever settings your action require

Configure Tutter action

Hooks can be configured just to send the event that you're interested in. The important part is that Payload URL points to the webserver running Tutter

https://github.com/ORG/PROJECT/settings/hooks/new

Example on how the thanks action looks like. Tutter listens for issue events and posts back with a greeting.

Build custom action

A simple action for getting started is the built in thanks action. More advanced usage can be seen in the tutter-sppuppet action that allows non-collaborators to merge pull requests

Required methods and their arguments

initialize

settings - contains a hash of action specific settings
client - Used to access the github api, all authentication is already done by tutter
project - Project name, eg jhaals/tutter
event - Event type
data - POST data that github send when a hook is triggered

run - Run action

Tutter uses octokit.rb to communicate with the Github API

Features to implement

• Authenticate as a Github application

tutter's Issues

Tutter messages can be out of order?

Tutter first commented that the PR was merged.
Then a few seconds later we got two messages saying that:

Pull request not mergeable: PUT XXXXXX: 405 - Pull Request is not mergeable // See: https://developer.github.com/enterprise/2.10/v3/pulls/#merge-a-pull-request-merge-button

And lastly that Merge state for is not clean. Current state: unknown I will try to merge this for you when the builds turn green If your build fails or becomes stuck for some reason, just say 'rebuild' If you have an incident and want to skip the tests or the peer review, please post the link to the jira ticket.

We believe that the messages are out order after a tryout. Can that be fixed or can we add a message just saying that "messages can be out of order" so that people dont get scared when it happens. This might happen every 20 PR:s but we have no data currently.

Support -2 for "do not merge"

It would be nice if tutter had some concept of -2 (aka Gerrit's "Do not merge") for changes which are dangerous and thus should not be automatically merged. Perhaps 💩 ? :)

Tutter doesn't respect github review +1 messages

This will not be recognized, so the reviewer has to [ost additional comment into main branch: