butaは命令に忠実なbotです

• 自動返信
• 任意の言語の実行
• Github issue登録
• Github pull request
• (要望があれば)Github project登録

このリポジトリをfork

実行させたいスクリプトをbin/に配置(スクリプトの先頭にシェバング(ex,#!/usr/bin/env node)と0755の権限が必要)

Node.js(>= v8.0.0)と実行させたいスクリプト(main.pyと仮定)の言語がinstallされたサーバーへデプロイ

環境変数をセットしてnpm start、もしくは下記のような.envファイルを作成

$cat .env
export TOOL=SLACK
export APPID=X-BUTA
export TOKEN=
export MAIN_SCRIPT_NAME=main.py
$source .env && npm start

nohupと&での実行 or systemctlなどを推奨

bot宛にmention付きでメッセージが送られた時(botが自分自身へmentionした場合を除く)

1. 依頼者宛に「受理しました」というメッセージが届く
2. 登録したスクリプトが実行される
3. 上記標準出力をメッセージとして送る（標準出力の形式によってGitHubと連携可能）

shでbin/your_script '<依頼者のID>' '<YYYY/MM/DD HH:mm:ss>' '<メッセージ内容>'が実行される

• より正確にはexecve("/bin/your_script", ["<依頼者のID>", "<YYYY/MM/DD HH:mm:ss>", "<メッセージ内容>"]
  • メッセージによるOS command injectionは起こらない
• メッセージ内容にはmention部分(@bot)と続くスペース・改行は含まない

上記shの実行結果によってレスポンスが変わる

• エラー（終了ステータスが0以外）の場合、依頼者宛に「処理が失敗しました」と詳細なエラーなどが送られる
• 終了ステータスが0の場合は、標準出力がJSONの場合は続くテンプレート処理の分岐に入り、そうでない場合は標準出力が返信される
  • 標準出力をtrimしてJSON.parse()した結果の成否で決まる

下記の点に注意

• タイムアウトは300秒
• 処理中に同ユーザーから別の処理依頼をされた場合、処理中の依頼の引用付きで「処理中です」という旨の返信を行い、依頼を無視する
• 確実に処理を行うことは保証できない
  • WebSocketの接続が途切れる、Node.jsのキューが詰まるなどで処理がスルーされる、etc

標準出力がJSONの場合、特定のキーを含んでいればテンプレート処理がなされる。 最終的な返信は、JSON内の"message"キーのバリューに、各テンプレート処理特有のレスポンスを付与して返す。

利用には実行時に下記環境変数が必要

export GITHUB_HOSTNAME=github.com
export GITHUB_REPOSITORY='your_org/your_repo'
export GITHUB_AUTH='personal token or username:passwd or oauth2token'

personal tokenやOAuth登録はhttps://github.com/darai0512/issue-ctl#setup などを参照