github • github_status_notifier • overview • status • travisci • circleci • ja

CI環境からGitHubのPull Requestのstatusを簡単に通知するコマンド

tl;dr

  • github_status_notifierコマンドでCI環境からGitHubのPull Requestのstatusを 簡単に通知する。
  • TravisCIがやってるみたいなテスト中は黄色、テスト終わったら緑/赤のを簡単に作れる。
github status pending github status success
github-status-notifierの実行結果イメージ

使い方

単体で使ってもよし、典型的には、他のコマンドの前後を state pendingと exit-status $?で囲んで使う。 こうするとこのスクリプトが始まったところでpending の黄色が始まり、成功/失敗で success/failureのstatusが表示できる。

gem install github_status_notifier

github-status-notifier notify --state pending --context saddler/rubocop

SOME_YOUR_COMMAND

github-status-notifier notify --exit-status $? --context saddler/rubocop

使い道

GitHub関連サービス作るような人には便利に使えそう。Saddlerとの連携などに便利。

チェックがまだ始まってないのか、チェック中なのか、チェックが終わって何も問題がないから無言なのか、途中で終わってるのか、 Pull Requestの画面上から把握できるようになる。

これから用にJenkinsなりで自前CIを作ってて、status通知連携だけで来てない人(いるのか?)は多少便利になるかも。 でもその場合はこっち見てその通りに作るほうがよい。 Building a CI server | GitHub API

ruby-github_status_notifierにスターください!

参照