More than 5 years have passed since last update.

dangerをCircleCI上で使ってPull Requestを精査する

Posted at 2017-07-03

Dangerとは

Dangerとは、ざっくり言うと、PRのレビューをするときに、"You Forgot To...(...するのを忘れてませんか？）"と指摘するのを自動化するツールらしいです。

似たようなツールとして、以前から packsaddle/ruby-saddler を使っていたのは、 Androidのコードを自動で解析し、GitHubのpull requestにコメントする - Qiita にも書いていました。

Android開発のコードレビューbotを乗り換えた話 - クックパッド開発者ブログを読むと、クックパッドさんもDokumiから乗り換えたということで、使ってみました。（ミーハー）
（ミーハーついでに、fastlaneとか作ってる Felix Krauseさんが絡んでる？というのも、やってみた要因の一つ）

上記のブログにもDokumi時代の問題点が書かれていましたが、私がSaddlerを使っていて感じている問題点は下記の通りです。
（Saddler自体の問題点じゃない気もします。）

シェルスクリプトで実行しているので、メンテしづらい。（シェル力が足りない）
プラグイン機構が（たぶん）無いため、シェルのパイプで繋げていく必要がある（シェル力が足りない）
checkstyle formatで出力できないものは、自分で変換しなければならない（無いものが多かったので、必要なものは作った https://rubygems.org/profiles/noboru_i ）

このあたりが、Dangerを使うことで楽になれば、本格的に乗り換えていこうかと思います。

試してみる

個人のAndroidプロジェクトに適用してみました。
https://github.com/noboru-i/SlideViewer

状況としては、下記のような感じ。

アプリはすでに一通り出来ている
CircleCIでのビルドもやってる
Rubyのツールとかは使ってない

最終的な差分としては、 https://github.com/noboru-i/SlideViewer/pull/62/files の通りです。

Ruby関連の設定、Danger gemの追加

まずは、 bundle init することで、 Gemfile の雛形を作成します。
作成された Gemfile に、 gem 'danger' を追加します。
bundle install --path vendor/bundle を実行し、
.gitignoreに /.bundle/ と /vendor/bundle を追加しました。

CircleCIでの実行の設定

circle.yml を下記のようなイメージで編集します。

machine:
  ruby:
    version: ruby-2.4.1
test:
  override:
    - bundle exec danger

Dangerfileの追加

クックパッド開発者ブログを参考に、とりあえずすぐにチェックが終わりそうなチェックを追加してみます。

# github comment settings
github.dismiss_out_of_range_messages

# for PR
if github.pr_title.include? "[WIP]" || github.pr_labels.include?("WIP")
  warn("PR is classed as Work in Progress") 
end

# Warn when there is a big PR
warn("a large PR") if git.lines_of_code > 300

# Warn when PR has no milestone
warn("A pull request must have a milestone set") if github.pr_json["milestone"].nil?

# Warn when PR has no assignees
warn("A pull request must have some assignees") if github.pr_json["assignee"].nil?