Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SonarQube に関するドキュメントを更新 #882

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 42 additions & 2 deletions SonarQube.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
# SonarQube

<!-- TOC -->

- [SonarQube](#sonarqube)
- [SonarQube および SonarCloud](#sonarqube-および-sonarcloud)
- [SonarQube](#sonarqube-1)
- [SonarCloud](#sonarcloud)
- [SonarQube のローカルでの使用方法](#sonarqube-のローカルでの使用方法)
- [SonarQube のアカウント設定](#sonarqube-のアカウント設定)
- [プロジェクトの作成](#プロジェクトの作成)
- [Access Token の作成](#access-token-の作成)
- [ローカルで実行する場合の環境設定 (事前準備)](#ローカルで実行する場合の環境設定-事前準備)
- [解析手順の流れ (一般論)](#解析手順の流れ-一般論)
- [解析手順の流れ (サクラエディタ)](#解析手順の流れ-サクラエディタ)
- [サクラエディタを SonarQube でビルドする手順](#サクラエディタを-sonarqube-でビルドする手順)
- [SonarQube に関する情報](#sonarqube-に関する情報)
- [SonarQube の使用方法に関するサイト](#sonarqube-の使用方法に関するサイト)
- [SonarScanner の使用方法](#sonarscanner-の使用方法)
- [CI でのビルド](#ci-でのビルド)
- [azure pipelines の設定](#azure-pipelines-の設定)
- [環境変数](#環境変数)
- [スケジュール設定](#スケジュール設定)
- [azure-pipelines.yml の設定](#azure-pipelinesyml-の設定)
- [Job の設定](#job-の設定)
- [Steps の設定](#steps-の設定)
- [Appveyor の設定](#appveyor-の設定)
- [Secure the GitHub Authentication token](#secure-the-github-authentication-token)

<!-- /TOC -->

<!-- 以下は Markdownの参照形式によるリンク の定義です。 -->
<!-- 参照 https://hail2u.net/blog/coding/markdown-reference-style-links.html -->

Expand Down Expand Up @@ -57,14 +86,25 @@ https://sonarcloud.io/projects/create にアクセスしてプロジェクトを
- Access Token をメモしておきます。
**この情報はパスワードと同じ意味を持つので漏れないように注意します。**

### Access Token の作成

https://sonarcloud.io/account/security/ のページでいつでも Access Token の作成、Revoke ができます。

ヘルプ: https://sonarcloud.io/documentation/user-guide/user-token/

### ローカルで実行する場合の環境設定 (事前準備)

1. https://www.java.com/ja/download/ から JAVA のランタイムをダウンロードしてインストールする
1. Oracle JRE8 の **64bit 版のランタイム** をダウンロードしてインストールする
1. Oracle JRE8 https://java.com/ja/download/manual.jsp (2019/05/02 現在)
1. Open JRE8 は Windows 版はダウンロードできなさそう。
1. 参考: [Prerequisites and Overview (Supported Platforms)](https://docs.sonarqube.org/latest/requirements/requirements/#header-3)
1. 参考: [SonarQubeの Java 11 対応状況](https://qiita.com/hayao_k/items/2cd81161f8dffd3a178b)

1. `JAVA_HOME` の環境変数を設定する


`set JAVA_HOME=C:\Program Files (x86)\Java\jre1.8.0_201`
`set JAVA_HOME=C:\Program Files\Java\jre1.8.0_211`

1. https://chocolatey.org/install#install-with-cmdexe を参考に chocolatey をインストールする。

Expand Down