koheisg / tokite

Tokite

Tokite send GitHub event (pull-request, issue and comment) to Slack.

Notification setting are personalized and customizable by query.

Installation

Tokite works as rails mountable engine.

Add this line to your rails application's Gemfile:

gem "tokite"

And mount engine.

Rails.application.routes.draw do
  mount Tokite::Engine => "/"
end

Setup database

$ ./bin/rails db:create
$ ./bin/rails tokite:ridgepole:install
$ ./bin/rails tokite:ridgepole:apply
$ RAILS_ENV=test ./bin/rails tokite:ridgepole:apply

Setup yarn pkg

$ ./bin/rails tokite:yarn:install

Configuration

GITHUB_CLIENT_ID	Google+ OAuth2 client ID
GITHUB_CLIENT_SECRET	Google+ OAuth2 client secret
GITHUB_HOST (optional)	GitHub Enterprise host
SECRET_KEY_BASE	rails secret key
SLACK_WEBHOOK_URL	Slack incoming webhook url
SLACK_NAME (optional)	Slack notification user name
SLACK_ICON_EMOJI (optional)	Slack notification icon
APP_HOST (optional)	Application host url

Usage

Supported Event

Tokite support only below events now.

• pull_request
• issues
• issue_comment

Supported query type

Name	Example
Plain word	hoge fuga moge
Quoted word	"hoge fuga moge"
Regular expression word	/hoge|fuga|moge/
Exclude word	-/(hoge|fuga|moge)/ -user:hogelog

Supported query field

Name	Description	Example
repo:	Match repository name.	repo:cookpad/tokite
title:	Match pull_request or issues title.	title:Bug
event:	Match event type pull_request, issues, issue_comment, pull_request_review, pull_request_review_comment.	event:/pull_request|issues|pull_request_review|pull_request_review_comment/
body:	Match body text.	body:"review please"
user:	Match user name.	user:hogelog
label:	Match pull_request or issue label.	label:Feature
review_state:	Match pull_request_review state.	review_state:/commented|approved|changes_requested/
unspecified	Match title or body field.	review please