【GitLab 公式 を訳してみた】コードの質をDiffで比較する方法

法律: IT 解説記事 GitLab CI フノス(訳者) マニュアル

GitLab Documentation > User documentation > Projects > Merge requests > コードの質をDiffで比較する 

  この機能はGitLab Enterprise Edition 9.3にて導入されました。

 

  概要

  GitLab CI/CDをご利用の方は、ソフトウェア品質のテストに「GitLab Code Quality」がお使いいただけます。
 Code Qualityとは、Code Climateエンジンでコードを解析する、無料・オープンソースソフトウェアです。コード解析に必要な設定が、すでに完了した状態で配布されています。
 

  次の図をご覧ください。GitLab Code Qualityは、コード解析の結果をマージリクエストウィジェットに表示してくれます。
 [gif画像 1]コード解析ウィジェット

 

  使いどころ

  大まかにいえば、次のような場面で有効でしょう。

  1. アプリの新しい機能を、より確実に素早く実装できる。バックエンドチームのメンバー全員でより均質な仕事ができる。
  2. ソフトウェア品質のレポートが提示されることで、試験段階の機能開発に、ある程度の指針を打ち出せる。
  3. コードの質を簡単に10段階評価で計測したい。
  4. 作業チーフに手直しを申し出るときに、具体的な修正項目を提示できる。
  5. アプリの改悪防止に。改良だけを享受できる。
  6. マージリクエストが正しいかどうかの基準になる。そのブランチを本当にデプロイするかどうかの判断に役立つ。
  7. ここで「正しい」と証明された場合、変更は「production」にデプロイされる。

 

  使い方

注:GitLab Enterprise Edition 10.0から、「codequality」というjob名称に対応する予定です。このjob名の採用により、GitLab 11.0以降は、これまでのjob名「codeclimate」が廃止される方針です。
.gitlab-ci.yml」の設定変更はお早めにお願いします。

  マージリクエストにレポートを提示できるようにするには、設定ファイルに「codequality」jobを設ける必要があります。このjobではコードを分析したうえで、その結果を「codeclimate.json」としてアップロードします。GitLabはこの結果を読み取り、マージリクエストの内部情報として表示します。

  このjobのアーティファクトは、原則として「codeclimate.json」ファイルしか出現しません。コード解析結果をHTMLファイルで出力して、マージリクエストに表示したい場合などは別途設定が必要です。

  もし、コード解析レポートがリクエスト画面に表示されなかったり、何の情報も表示されなかった場合は、まず「.gitlab-ci.yml」に「codequality」jobが追加されているかどうかをご確認ください。正しく動作している場合は、きちんとした情報とコード解析レポートが表示されるはずです。

  このjobの詳しい設定方法は、『コードの質を「Code Climate CLI」に判定してもらう設定』で紹介されています。

 Edit this page

 

 

 2018-03-23 21:37:26 / Hnoss
原文サイトを表示
[ 原文 ] https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html
原文ページプロジェクト並びにドキュメントファイルは、MIT Licenseのもと公開されています。(URL:https://gitlab.com/gitlab-com/gitlab-docs/blob/master/LICENSE) この記事の文章は、訳者の判断によりCreative Commons BY (version 3.0) を適用するものとします。