GitHub + Code Climate で Pull request の度に保守性を自動チェックする

この記事は、 OIT Advent Calendar 2018の9日目の記事です。

はじめに

Quality by Code Climate を GitHub と連携させることで、ソースコードの保守性やテストカバレッジを自動コードレビューでチェックすることができます。また、 GitHub 上の Public repository であれば無料で利用できます。
今回は、保守性を自動チェックする方法を紹介します。

Code Climate の設定

1. Quality by Code Climate にアクセス
2. Login を選択
3. Open source を選択
4. Add a repository を選択
5. 任意の repository で Add Repo を選択
6. Repo Settings を選択
7. GitHub を選択 (下図参照)
   1. Summary comments を ON に設定
   2. Inline issue comments を ON に設定
   3. Save を選択
   4. Edit を選択
   5. Active? を ON に設定
   6. Save を選択
   7. Install を選択

これで準備 OK です。

保守性 (maintainability) を自動チェック

GitHub で master ブランチ宛に Pull request を送信するだけで、自動コードレビューが実行されます。
数秒後、 Pull request に Code Climate からコメントが届きます。 (下図参照)

repository のレーティングを表示

repository の保守性 (Maintainability) は A 〜 F の 6 段階でレーティングされます。 Repo Settings の Badges で Maintainability Badge の画像 URL を取得し、 README.md などに貼り付けてレーティングを表示できます。

表示例)

さいごに

Quality by Code Climate との連携でソースコードの保守性を簡単にチェックすることができます。リファクタリングによってレーティングが上がるとモチベーションも上がるのでおすすめです。
素敵なコーディングライフを送ってください。