Sonar掃描之分析參數介紹

強制參數

服務器

Key	描述	默認
sonar.host.url	服務器網址	http://localhost:9000

項目配置

Key	描述	默認
sonar.projectKey	項目的唯一標識。允許的字符是：字母，數字，-，_，.和:，與至少一個非數字字符。	對於 Maven 項目，這默認為 <groupId>:<artifactId>

可選參數

項目標識

Key	描述	默認
sonar.projectName	將顯示在 Web 界面上的項目名稱。	針對 Maven 項目，默認為<name>，否則為projectKey。如果未提供且數據庫中已有名稱，則不會被覆蓋
sonar.projectVersion	項目版本。	針對 Maven 項目，默認為<version> ，否則“not provided”

認證

默認情況下，需要用戶身份驗證以防止匿名用戶瀏覽和分析您實例上的項目，所以運行分析時需要傳遞這些參數。身份驗證在全局安全 (/instance-administration/security/) 配置中強制執行。

當需要身份驗證或歸屬pseudo-group的“任何人”沒有執行分析的權限時，需要提供具有執行分析權限的用戶憑據，以便運行分析。

Key	描述	默認
sonar.login	對項目具有執行分析權限的 SonarQube 用戶的身份驗證令牌或登錄名。
sonar.password	如果您使用身份驗證令牌，該配置項保持為空，如果您使用登錄名，則這是與您的sonar.login用戶名一起使用的密碼。

網頁服務

Key	描述	默認
sonar.ws.timeout	等待 Web 服務調用響應的最長時間（以秒為單位）。僅當在分析期間等待服務器響應 Web 服務調用超時時才需要修改該參數配置。	60

項目配置

Key	描述	默認
sonar.projectDescription	項目描述。	對於 Maven 項目，默認為<description>
sonar.links.homepage	項目主頁。	對於 Maven 項目，默認為<url>
sonar.links.ci	持續集成。	對於 Maven 項目，默認為<ciManagement><url>
sonar.links.issue	問題跟蹤器。	對於 Maven 項目，默認為<issueManagement><url>
sonar.links.scm	項目源代碼庫。	對於 Maven 項目，默認為<scm><url>
sonar.sources	包含主要源文件，由逗號分隔(如果有多個的話)的目錄路徑。	從 Maven、Gradle、MSBuild 項目的構建系統讀取。當既不提供sonar.sources也不sonar.tests提供時，默認為項目根目錄。
sonar.tests	包含測試源文件，由逗號分隔(如果有多個的話)的目錄路徑。	從 Maven、Gradle、MSBuild 項目的構建系統中讀取。否則默認為空。
sonar.sourceEncoding	源文件的編碼。例如：UTF-8, MacRoman, Shift_JIS。Maven 項目中，這個屬性可以替換為project.build.sourceEncoding標准屬性。可用編碼列表取決於 JVM。	系統編碼
sonar.externalIssuesReportPaths	通用問題報告的逗號分隔路徑列表。
sonar.projectBaseDir	當您需要在不同於啟動目錄的目錄中進行分析時，請使用此屬性。該路徑可以是相對的或絕對的。注意，不是指定源代碼目錄，而是指定源代碼目錄的某個父目錄。注意分析過程中需要這個目錄的寫權限；這是sonar.working.directory被創建的地方。
sonar.working.directory	為使用 SonarScanner 或 SonarScanner for Ant（大於 2.0 的版本）觸發的分析設置工作目錄。此屬性與 MSBuild 的 SonarScanner 不兼容。路徑必須是相對的，並且對於每個項目都是唯一的。注意：每次分析前都會刪除該配置指定的目錄。	.scannerwork

質量門

鑰匙	描述	默認
sonar.qualitygate.wait	強制分析步驟輪詢 SonarQube 實例並等待 Quality Gate 狀態。如果沒有其他選項，當Quality Gate 失敗時，可以使用該配置讓管道構建失敗。更多相關信息，請參閱CI 集成頁面。
sonar.qualitygate.timeout	設置scanner應等待處理報告的秒數。	300

更多參數配置說明，請查閱參考鏈接。

參考連接

https://docs.sonarqube.org/latest/analysis/analysis-parameters/