GitLab CI と SonarCloud の連携設定のメモです。
SonarCloud とは
SonarQube の SaaS 版が SonaCloud です。
SonarQube は「コードを解析してソフトウェアの健康状態をチェックしてくれるツール」てなイメージのものです。 SonarQube の詳細については私が以前書いた以下の記事をぜひ!!
SonarCloud と GitLab の連携方法
SonarCloud と GitLab の連携は、びっくりするぐらい簡単です。
以下の3ステップでできます。
- SonaCloud を開く。
- 「GitLab」をクリックする
- あとは画面の指示に従って設定を行う
設定の詳細は SonarCloudのドキュメント に書かれています。が、これ読まなくてもほぼ画面の指示だけでできるはず。
さらに以下の2点について事前に意識しておくと、より作業時間短縮できます。
- GitLab のアクセストークン取得
- 課金の要件
GitLab のアクセストークン取得
SonarCloud の設定中に GitLab のアクセストークン入力が求められます。 アクセストークンは、ユーザー設定画面の「アクセストークン」で作成できます。 この際、 api スコープにチェックを入れておく必要があります。
なお、ユーザー設定画面の表示は GitLab の画面右上にある自分のアイコンをクリックして「Preference」をクリックです。
課金の要件
SonarCloud に読み込む GitLab グループ内にプライベートプロジェクト (リポジトリ) があれば利用料金が発生します。 逆にいうと、「全てパブリックなプロジェクトしかないグループ」を対象にする場合は無料で利用可能です。(この場合はクレジットカードの登録も不要です)
ですので「とりあえずどんなものか試してみたい」という場合は、事前に GitLab 側で新規にグループを作ってその中に公開可能なプロジェクトをひとつ置いた状態から SonarCloud の設定を始めるのがおすすめです。その後でプライベートなプロジェクトが扱いたくなった場合は、Organizations - My Account を開いて、新しい組織 (organization) を追加すればOKです。
実際に作ってみた
実際にお試しで作ってみたプロジェクトがこちら: https://sonarcloud.io/dashboard?id=knowledge-swimmer_ci-cd-demo
今日はすいすい泳げました。