Sonar 扫描之分析参数介绍

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/